Class: C128BObject

From IHRIS Wiki
Revision as of 21:27, 16 October 2009 by Litlfred (talk | contribs)

This article desrcibes the class C128BObject which extends the class BarcodeObject It is contained in the module tcpdf in the package TextLayout Tools

The class is defined in the file: modules/tcpdf/tcpdf/barcode/c128bobject.php

Code 128-B Barcode Render Class for PHP using the GD graphics library.

Code 128-B is a continuous, multilevel and full ASCII code.

@author Karim Mribti, Nicola Asuni

@name BarcodeObject

@package com.tecnick.tcpdf

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

@since 2001-03-25

@license http://www.gnu.org/copyleft/lesser.html LGPL

Code 128-B Barcode Render Class for PHP using the GD graphics library.

Code 128-B is a continuous, multilevel and full ASCII code.

@author Karim Mribti, Nicola Asuni

@name BarcodeObject

@package com.tecnick.tcpdf

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

@since 2001-03-25

@license http://www.gnu.org/copyleft/lesser.html LGPL

Methods

DrawCheckChar()

Draws the check-char code.

  • Signature: private function DrawCheckChar($DrawPos,$yPos,$ySize,$xres)
  • Returns: int drawing position.

@access private Parameters:

  • int $DrawPos
    Drawing position.
  • int $yPos
    Vertical position.
  • int $ySize
    Vertical size.
  • int $xres
    Horizontal resolution.

DrawObject()

Draws the barcode object.

  • Signature: public function DrawObject($xres)
  • Returns: bool true in case of success.

Parameters:

  • int $xres
    Horizontal resolution.

DrawStart()

Draws the start code.

  • Signature: private function DrawStart($DrawPos,$yPos,$ySize,$xres)
  • Returns: int drawing position.

@access private Parameters:

  • int $DrawPos
    Drawing position.
  • int $yPos
    Vertical position.
  • int $ySize
    Vertical size.
  • int $xres
    Horizontal resolution.

DrawStop()

Draws the stop code.

  • Signature: private function DrawStop($DrawPos,$yPos,$ySize,$xres)
  • Returns: int drawing position.

@access private Parameters:

  • int $DrawPos
    Drawing position.
  • int $yPos
    Vertical position.
  • int $ySize
    Vertical size.
  • int $xres
    Horizontal resolution.

GetBarSize()

Returns the bar size.

  • Signature: private function GetBarSize($xres,$char)
  • Returns: int barcode size.

@access private Parameters:

  • int $xres
    Horizontal resolution.
  • char $char
    Character.

GetCharIndex()

Returns the character index.

  • Signature: private function GetCharIndex($char)
  • Returns: int character index or -1 in case of error.

@access private Parameters:

  • char $char
    character.

GetCheckCharValue()

Returns the check-char value.

  • Signature: private function GetCheckCharValue()
  • Returns: string.

@access private

GetSize()

Returns barcode size.

  • Signature: private function GetSize($xres)
  • Returns: barcode size.

@access private Parameters:

  • int $xres
    Horizontal resolution.

__construct()

Class Constructor.

  • Signature: public function __construct($Width,$Height,$Style,$Value)

Parameters:

  • int $Width
    Image width in pixels.
  • int $Height
    Image height in pixels.
  • int $Style
    Barcode style.
  • int $Value
    value to print on barcode.