Class: C128AObject: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the class '''C128AObject''' which extends the class BarcodeObject
This article desrcibes the class '''C128AObject'''.
*Extends the class: BarcodeObject.
It is contained in the module [[iHRIS Module List#tcpdf|tcpdf]] in the package [https://launchpad.net/textlayout TextLayout Tools]
It is contained in the module [[iHRIS Module List#tcpdf|tcpdf]] in the package [https://launchpad.net/textlayout TextLayout Tools]


Line 22: Line 23:
Draws the check-char code.
Draws the check-char code.
*Signature: private function DrawCheckChar($DrawPos,$yPos,$ySize,$xres)
*Signature: private function DrawCheckChar($DrawPos,$yPos,$ySize,$xres)
*Returns: [http://www.php.net/manual/en/language.types.integer.php int] drawing position.
*Returns: [http://www.php.net/manual/en/language.types.integer.php int ] drawing position.
@access private
@access private
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $DrawPos<br/>Drawing position.
* [http://www.php.net/manual/en/language.types.integer.php int ] $DrawPos<br/>Drawing position.
* [http://www.php.net/manual/en/language.types.integer.php int] $yPos<br/>Vertical position.
* [http://www.php.net/manual/en/language.types.integer.php int ] $yPos<br/>Vertical position.
* [http://www.php.net/manual/en/language.types.integer.php int] $ySize<br/>Vertical size.
* [http://www.php.net/manual/en/language.types.integer.php int ] $ySize<br/>Vertical size.
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
* [http://www.php.net/manual/en/language.types.integer.php int ] $xres<br/>Horizontal resolution.
===DrawObject()===
===DrawObject()===
Draws the barcode object.
Draws the barcode object.
*Signature: public function DrawObject($xres)
*Signature: public function DrawObject($xres)
*Returns: [http://www.php.net/manual/en/language.types.boolean.php bool] true in case of success.
*Returns: [http://www.php.net/manual/en/language.types.boolean.php bool ] true in case of success.
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
* [http://www.php.net/manual/en/language.types.integer.php int ] $xres<br/>Horizontal resolution.
===DrawStart()===
===DrawStart()===
Draws the start code.
Draws the start code.
*Signature: private function DrawStart($DrawPos,$yPos,$ySize,$xres)
*Signature: private function DrawStart($DrawPos,$yPos,$ySize,$xres)
*Returns: [http://www.php.net/manual/en/language.types.integer.php int] drawing position.
*Returns: [http://www.php.net/manual/en/language.types.integer.php int ] drawing position.
@access private
@access private
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $DrawPos<br/>Drawing position.
* [http://www.php.net/manual/en/language.types.integer.php int ] $DrawPos<br/>Drawing position.
* [http://www.php.net/manual/en/language.types.integer.php int] $yPos<br/>Vertical position.
* [http://www.php.net/manual/en/language.types.integer.php int ] $yPos<br/>Vertical position.
* [http://www.php.net/manual/en/language.types.integer.php int] $ySize<br/>Vertical size.
* [http://www.php.net/manual/en/language.types.integer.php int ] $ySize<br/>Vertical size.
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
* [http://www.php.net/manual/en/language.types.integer.php int ] $xres<br/>Horizontal resolution.
===DrawStop()===
===DrawStop()===
Draws the stop code.
Draws the stop code.
*Signature: private function DrawStop($DrawPos,$yPos,$ySize,$xres)
*Signature: private function DrawStop($DrawPos,$yPos,$ySize,$xres)
*Returns: [http://www.php.net/manual/en/language.types.integer.php int] drawing position.
*Returns: [http://www.php.net/manual/en/language.types.integer.php int ] drawing position.
@access private
@access private
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $DrawPos<br/>Drawing position.
* [http://www.php.net/manual/en/language.types.integer.php int ] $DrawPos<br/>Drawing position.
* [http://www.php.net/manual/en/language.types.integer.php int] $yPos<br/>Vertical position.
* [http://www.php.net/manual/en/language.types.integer.php int ] $yPos<br/>Vertical position.
* [http://www.php.net/manual/en/language.types.integer.php int] $ySize<br/>Vertical size.
* [http://www.php.net/manual/en/language.types.integer.php int ] $ySize<br/>Vertical size.
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
* [http://www.php.net/manual/en/language.types.integer.php int ] $xres<br/>Horizontal resolution.
===GetBarSize()===
===GetBarSize()===
Returns the bar size.
Returns the bar size.
*Signature: private function GetBarSize($xres,$char)
*Signature: private function GetBarSize($xres,$char)
*Returns: [http://www.php.net/manual/en/language.types.integer.php int] barcode size.
*Returns: [http://www.php.net/manual/en/language.types.integer.php int ] barcode size.
@access private
@access private
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
* [http://www.php.net/manual/en/language.types.integer.php int ] $xres<br/>Horizontal resolution.
* char $char<br/>Character.
* char $char<br/>Character.
===GetCharIndex()===
===GetCharIndex()===
Returns the character index.
Returns the character index.
*Signature: private function GetCharIndex($char)
*Signature: private function GetCharIndex($char)
*Returns: [http://www.php.net/manual/en/language.types.integer.php int] character index or -1 in case of error.
*Returns: [http://www.php.net/manual/en/language.types.integer.php int ] character index or -1 in case of error.
@access private
@access private
Parameters:
Parameters:
Line 81: Line 82:
@access private
@access private
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
* [http://www.php.net/manual/en/language.types.integer.php int ] $xres<br/>Horizontal resolution.
===__construct()===
===__construct()===
Class Constructor.
Class Constructor.
*Signature: public function __construct($Width,$Height,$Style,$Value)
*Signature: public function __construct($Width,$Height,$Style,$Value)
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $Width<br/>Image width in pixels.
* [http://www.php.net/manual/en/language.types.integer.php int ] $Width<br/>Image width in pixels.
* [http://www.php.net/manual/en/language.types.integer.php int] $Height<br/>Image height in pixels.
* [http://www.php.net/manual/en/language.types.integer.php int ] $Height<br/>Image height in pixels.
* [http://www.php.net/manual/en/language.types.integer.php int] $Style<br/>Barcode style.
* [http://www.php.net/manual/en/language.types.integer.php int ] $Style<br/>Barcode style.
* [http://www.php.net/manual/en/language.types.integer.php int] $Value<br/>value to print on barcode.
* [http://www.php.net/manual/en/language.types.integer.php int ] $Value<br/>value to print on barcode.




[[Category:Class Documentation]]
[[Category:Class Documentation]]

Revision as of 21:27, 16 October 2009

This article desrcibes the class C128AObject.

  • 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/c128aobject.php

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. @name BarcodeObject @license http://www.gnu.org/copyleft/lesser.html LGPL 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. @name BarcodeObject @license http://www.gnu.org/copyleft/lesser.html LGPL

  • Author: Karim Mribti, Nicola Asuni
  • Author: Karim Mribti, Nicola Asuni
  • Since: 2001-03-25
  • Since: 2001-03-25

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.
Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_C128AObject&oldid=6745"