Class: C128BObject: Difference between revisions

From IHRIS Wiki
No edit summary
(Redirected page to Class: C128BObject (4.1.12))
 
(24 intermediate revisions by one other user not shown)
Line 1: Line 1:
This article desrcibes the class '''C128BObject''' which extends the class BarcodeObject
#REDIRECT [[Class: C128BObject (4.1.12)]]
It is contained in the module [[iHRIS Module List#tcpdf|tcpdf]] in the package [https://launchpad.net/textlayout TextLayout Tools]
 
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.0-release/annotate/head:/modules/tcpdf/tcpdf/barcode/c128bobject.php modules/tcpdf/tcpdf/barcode/c128bobject.php]
 
Code 128-B Barcode Render Class for PHP using the GD graphics library.<br>
 
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.<br>
 
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: [http://www.php.net/manual/en/language.types.integer.php int] drawing position.
@access private
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] $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] $xres<br/>Horizontal resolution.
===DrawObject()===
Draws the barcode object.
*Signature: public function DrawObject($xres)
*Returns: [http://www.php.net/manual/en/language.types.boolean.php bool] true in case of success.
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
===DrawStart()===
Draws the start code.
*Signature: private function DrawStart($DrawPos,$yPos,$ySize,$xres)
*Returns: [http://www.php.net/manual/en/language.types.integer.php int] drawing position.
@access private
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] $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] $xres<br/>Horizontal resolution.
===DrawStop()===
Draws the stop code.
*Signature: private function DrawStop($DrawPos,$yPos,$ySize,$xres)
*Returns: [http://www.php.net/manual/en/language.types.integer.php int] drawing position.
@access private
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] $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] $xres<br/>Horizontal resolution.
===GetBarSize()===
Returns the bar size.
*Signature: private function GetBarSize($xres,$char)
*Returns: [http://www.php.net/manual/en/language.types.integer.php int] barcode size.
@access private
Parameters:
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
* char $char<br/>Character.
===GetCharIndex()===
Returns the character index.
*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.
@access private
Parameters:
* char $char<br/>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:
* [http://www.php.net/manual/en/language.types.integer.php int] $xres<br/>Horizontal resolution.
===__construct()===
Class Constructor.
*Signature: public function __construct($Width,$Height,$Style,$Value)
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] $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] $Value<br/>value to print on barcode.
 
 
[[Category:Class Documentation]]

Latest revision as of 09:41, 18 August 2015