com-tecnick-tcpdf
[ class tree: com-tecnick-tcpdf ] [ index: com-tecnick-tcpdf ] [ all elements ]
Packages:
com-tecnick-tcpdf


Files:
BarcodeObject
BarcodeObject
BarcodeObject
BarcodeObject
BarcodeObject
BarcodeObject
BarcodeObject
html_entity_decode_php4.php
TCPDF
tcpdf_config.php
unicode_data.php

Classes:
BarcodeObject
C39Object
C128AObject
C128BObject
C128CObject
I25Object
TCPDF

Class: BarcodeObject

Source Location: /tcpdf/barcode/barcode.php

Class Overview




Barcode Render Class for PHP using the GD graphics library.




Author(s):


    
          
  • Karim Mribti, Nicola Asuni
    • 
                              





        
                

Version:


    
  
  • 0.0.8a 2001-04-01 (original code)
    • 



        




Variables







Methods















Child classes:






C39Object

	
Code 39 Barcode Render Class.
  Code 39 is an alphanumeric bar code that can encode decimal number, case alphabet and some special symbols.






C128AObject

	
Code 128-A Barcode Render Class for PHP using the GD graphics library.
  Code 128-A is a continuous, multilevel and include all upper case alphanumeric characters and ASCII control characters.






C128BObject

	
Code 128-B Barcode Render Class for PHP using the GD graphics library.
  Code 128-B is a continuous, multilevel and full ASCII code.






C128CObject

	
Code 128-C Barcode Render Class for PHP using the GD graphics library.
  Code 128-C is numeric only and provides the most efficiency.






I25Object

	
I25 Barcode Render Class for PHP using the GD graphics library.

















Class Details



[line 209]

Barcode Render Class for PHP using the GD graphics library.





Tags:





  

    author:  Karim Mribti, Nicola Asuni
  

  

    version:  0.0.8a 2001-04-01 (original code)
  

  

    since:  2001-03-25
  

  

    name:  BarcodeObject
  

  

    license:  LGPL
  










[ Top ]







Class Variables



	
	

	
$mBgcolor = 

	
[line 232]

  



Tags:





  

    var:  color.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Background
    

      

	



	
[ Top ]


	
	

	
$mBrush = 

	
[line 238]

  



Tags:





  

    var:  color.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Brush
    

      

	



	
[ Top ]


	
	

	
$mChars = 

	
[line 268]

  



Tags:





  

    var:  symbols.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Allowed
    

      

	



	
[ Top ]


	
	

	
$mCharSet = 

	
[line 262]

  



Tags:





  

    var:  Set.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Character
    

      

	



	
[ Top ]


	
	

	
$mError = 

	
[line 256]

  



Tags:





  

    var:  message.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Error
    

      

	



	
[ Top ]


	
	

	
$mFont = 

	
[line 250]

  



Tags:





  

    var:  code for character font.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Numeric
    

      

	



	
[ Top ]


	
	

	
$mHeight = 

	
[line 220]

  



Tags:





  

    var:  height in pixels.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Image
    

      

	



	
[ Top ]


	
	

	
$mImg = 

	
[line 244]

  



Tags:





  

    var:  object.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Image
    

      

	



	
[ Top ]


	
	

	
$mStyle = 

	
[line 226]

  



Tags:





  

    var:  code for Barcode style.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Numeric
    

      

	



	
[ Top ]


	
	

	
$mWidth = 

	
[line 214]

  



Tags:





  

    var:  width in pixels.
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Image
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 276]

	

    

    

		BarcodeObject __construct(
[int
$Width = BCD_DEFAULT_WIDTH], [int
$Height = BCD_DEFAULT_HEIGHT], [int
$Style = BCD_DEFAULT_STYLE])
    

    


	
		Class Constructor.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
C39Object::__construct()

		
Class Constructor.

	

		

	
C128AObject::__construct()

		
Class Constructor.

	

		

	
C128BObject::__construct()

		
Class Constructor.

	

		

	
C128CObject::__construct()

		
Class Constructor.

	

		

	
I25Object::__construct()

		
Class Constructor.

	

	

	
        
Parameters:

    

    

          

        int  
        $Width  
        Image width in pixels.
      

          

        int  
        $Height  
        Image height in pixels.
      

          

        int  
        $Style  
        Barcode style.
      

        

    


        
[ Top ]

  

  

	
	
method DestroyObject [line 441]

	

    

    

		void DestroyObject(
)
    

    


	
		Destroy the barcode image.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method DrawBorder [line 324]

	

    

    

		void DrawBorder(
)
    

    


	
		Draws the barcode border.





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method DrawChar [line 336]

	

    

    

		void DrawChar(
int
$Font, int
$xPos, int
$yPos, int
$Char)
    

    


	
		Draws the alphanumeric code.





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        int  
        $Font  
        Font type.
      

          

        int  
        $xPos  
        Horiziontal position.
      

          

        int  
        $yPos  
        Vertical position.
      

          

        int  
        $Char  
        Alphanumeric code to write.
      

        

    


        
[ Top ]

  

  

	
	
method DrawObject [line 315]

	

    

    

		void DrawObject(
int
$xres)
    

    


	
		Abstract method used to draw the barcode image.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
C39Object::DrawObject()

		
Draws the barcode object.

	

		

	
C128AObject::DrawObject()

		
Draws the barcode object.

	

		

	
C128BObject::DrawObject()

		
Draws the barcode object.

	

		

	
C128CObject::DrawObject()

		
Draws the barcode object.

	

		

	
I25Object::DrawObject()

		
Draws the barcode object.

	

	

	
        
Parameters:

    

    

          

        int  
        $xres  
        Horizontal resolution.
      

        

    


        
[ Top ]

  

  

	
	
method DrawSingleBar [line 361]

	

    

    

		bool DrawSingleBar(
int
$xPos, int
$yPos, int
$xSize, 
$ySize)
    

    


	
		Draws a single barcode bar.





Tags:





  

    return:  trur in case of success, false otherwise.
  

  

    access:  protected
  









	
        
Parameters:

    

    

          

        int  
        $xPos  
        Horiziontal position.
      

          

        int  
        $yPos  
        Vertical position.
      

          

        int  
        $xSize  
        Vertical size.
      

          

          
        $ySize  
        
      

        

    


        
[ Top ]

  

  

	
	
method DrawText [line 348]

	

    

    

		void DrawText(
int
$Font, int
$xPos, int
$yPos, int
$Char)
    

    


	
		Draws a character string.





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        int  
        $Font  
        Font type.
      

          

        int  
        $xPos  
        Horiziontal position.
      

          

        int  
        $yPos  
        Vertical position.
      

          

        int  
        $Char  
        string to write.
      

        

    


        
[ Top ]

  

  

	
	
method FlushObject [line 425]

	

    

    

		void FlushObject(
)
    

    


	
		Flush the barcode image.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method GetError [line 376]

	

    

    

		string GetError(
)
    

    


	
		Returns the current error message.





Tags:





  

    return:  error message.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method GetFontHeight [line 385]

	

    

    

		int GetFontHeight(
int
$font)
    

    


	
		Returns the font height.





Tags:





  

    return:  font height.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $font  
        font type.
      

        

    


        
[ Top ]

  

  

	
	
method GetFontWidth [line 394]

	

    

    

		int GetFontWidth(
int
$font)
    

    


	
		Returns the font width.





Tags:





  

    return:  font width.
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $font  
        font type.
      

        

    


        
[ Top ]

  

  

	
	
method getImage [line 307]

	

    

    

		object image. getImage(
)
    

    


	
		Returns the image object.





Tags:





  

    author:  Nicola Asuni
  

  

    since:  1.5.2
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method GetStyle [line 410]

	

    

    

		int GetStyle(
)
    

    


	
		Returns barcode style.





Tags:





  

    return:  barcode style.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method SetFont [line 402]

	

    

    

		void SetFont(
int
$font)
    

    


	
		Set font type.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $font  
        font type.
      

        

    


        
[ Top ]

  

  

	
	
method SetStyle [line 418]

	

    

    

		void SetStyle(
int
$Style)
    

    


	
		Set barcode style.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $Style  
        barcode style.
      

        

    


        
[ Top ]

  

  

	
	
method __destructor [line 297]

	

    

    

		void __destructor(
)
    

    


	
		Class Destructor.

Destroy image object.





Tags:





  

    access:  public
  









	
        
[ Top ]

  






        

		    

		    Documentation generated on Wed, 21 May 2008 11:58:58 +0200 by phpDocumentor 1.4.0