Class: BarcodeObject

Source Location: /class/system/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:

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.

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

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

Class Details

[line 210]
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 233]

Tags:

var:	color.
access:	protected

Type:

Background

[ Top ]

$mBrush =

[line 239]

Tags:

var:	color.
access:	protected

Type:

Brush

[ Top ]

$mChars =

[line 269]

Tags:

var:	symbols.
access:	protected

Type:

Allowed

[ Top ]

$mCharSet =

[line 263]

Tags:

var:	Set.
access:	protected

Type:

Character

[ Top ]

$mError =

[line 257]

Tags:

var:	message.
access:	protected

Type:

Error

[ Top ]

$mFont =

[line 251]

Tags:

var:	code for character font.
access:	protected

Type:

Numeric

[ Top ]

$mHeight =

[line 221]

Tags:

var:	height in pixels.
access:	protected

Type:

Image

[ Top ]

$mImg =

[line 245]

Tags:

var:	object.
access:	protected

Type:

Image

[ Top ]

$mStyle =

[line 227]

Tags:

var:	code for Barcode style.
access:	protected

Type:

Numeric

[ Top ]

$mWidth =

[line 215]

Tags:

var:	width in pixels.
access:	protected

Type:

Image

[ Top ]

Class Methods

constructor __construct [line 277]

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

Class Constructor.

Parameters:

int	$Width	Image width in pixels.
int	$Height	Image height in pixels.
int	$Style	Barcode style.

[ Top ]

method DestroyObject [line 442]

void DestroyObject(
)

Destroy the barcode image.

Tags:

access:

public

[ Top ]

method DrawBorder [line 325]

void DrawBorder(
)

Draws the barcode border.

Tags:

access:

protected

[ Top ]

method DrawChar [line 337]

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 316]

void DrawObject(
int
$xres)

Abstract method used to draw the barcode image.

Parameters:

int

$xres

Horizontal resolution.

[ Top ]

method DrawSingleBar [line 362]

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 349]

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 426]

void FlushObject(
)

Flush the barcode image.

Tags:

access:

public

[ Top ]

method GetError [line 377]

string GetError(
)

Returns the current error message.

Tags:

return:	error message.
access:	public

[ Top ]

method GetFontHeight [line 386]

int GetFontHeight(
int
$font)

Returns the font height.

Tags:

return:	font height.
access:	public

Parameters:

int

$font

font type.

[ Top ]

method GetFontWidth [line 395]

int GetFontWidth(
int
$font)

Returns the font width.

Tags:

return:	font width.
access:	public

Parameters:

int

$font

font type.

[ Top ]

method getImage [line 308]

object image. getImage(
)

Returns the image object.

Tags:

author:	Nicola Asuni
since:	1.5.2
access:	public

[ Top ]

method GetStyle [line 411]

int GetStyle(
)

Returns barcode style.

Tags:

return:	barcode style.
access:	public

[ Top ]

method SetFont [line 403]

void SetFont(
int
$font)

Set font type.

Tags:

access:

public

Parameters:

int

$font

font type.

[ Top ]

method SetStyle [line 419]

void SetStyle(
int
$Style)

Set barcode style.

Tags:

access:

public

Parameters:

int

$Style

barcode style.

[ Top ]

method __destructor [line 298]

void __destructor(
)

Class Destructor.

Destroy image object.

Tags:

access:

public

[ Top ]

Documentation generated on Sat, 08 Nov 2008 14:50:59 +0100 by phpDocumentor 1.4.1