Docs For Class Image_Text

Description

Image_Text_Line Class that represents a line in the Image_Text object

license: http://www.php.net/license/3_0.txt
author: Tobias Schlitt <mailto:tobias@schlitt.info>
access: public

Located in /Image_Text_Line.php (line 14)

Variable Summary

int $options

array $tokens

Method Summary

Image_Text_Line Image_Text_Line (string $text, [mixed $options = null])

void addShadow (int $xAdjust, int $yAdjust, array $color)

void align (const $alignment, int $width, string $font)

void colorize (array $color)

string currentToken ()

string firstToken ()

array getSize (string $font, [int $fontsize = null])

string getText ()

array getTokens ()

string nextToken ()

string popToken ()

void pushToken (string $token)

void rotate (mixed $angle)

void toImage (resource &$img, int $x, int $y, string $font)

Variables

int $options = array(
'fontSize' => 1,
'color' => array('r' => 255, 'g' => 255, 'b' => 255),'align'=>IMAGE_TEXT_ALIGN_LEFT,'angle'=>0,'antiAliasing'=>true,'shadowX'=>false,'shadowY'=>false,'shadowColor'=>false) (line 32)

Fontsize of the line.

access: public

array $tokens = array() (line 23)

Array of string tokens, building the line.

var: string
access: public

Methods

Constructor Image_Text_Line (line 59)

Constructor Constructor

access: public

Image_Text_Line Image_Text_Line (string $text, [mixed $options = null])

string $text: The text of the line.

addShadow (line 162)

Add a shadow to your text.

access: public

void addShadow (int $xAdjust, int $yAdjust, array $color)

int $xAdjust: Adjustment in x direction
int $yAdjust: Adjustment in y direction
array $color: The color to set.

align (line 109)

Align the line in a given box width.

access: public

void align (const $alignment, int $width, string $font)

const $alignment: A constant which determines the alignement.
int $width: The width of the box to align in.
string $font: The fontfile to use for rendering.

colorize (line 140)

Set color of the line.

access: public

void colorize (array $color)

array $color: The color to set.

currentToken (line 242)

Return the current selected token Return the current selected token

return: The current token
access: public

string currentToken ()

firstToken (line 266)

Return the first token and select it Return the first token and select it

return: The first token
access: public

string firstToken ()

getSize (line 202)

Determine the size of the line in a given font and size Determine the size of the line in a given font and size

return: Width and height of the line
access: public

array getSize (string $font, [int $fontsize = null])

string $font: The fontfile to use
int $fontsize: The fontsize to use (optional)

getText (line 176)

Returns the line text Returns the line text

return: The text of the line
access: public

string getText ()

getTokens (line 188)

Returns the lines tokens Returns the lines tokens

return: The text of the line in tokens
access: public

array getTokens ()

nextToken (line 254)

Return the next token and select it Return the next token and select it

return: The next token
access: public

string nextToken ()

popToken (line 230)

Pop a token from the line Pop a token from the line

return: The token poped away
access: public

string popToken ()

pushToken (line 218)

Add a token to the line Add a token to the line

access: public

void pushToken (string $token)

string $token: The token to add

rotate (line 148)

NOT CORRECT IMPLEMENTED YET!!!

void rotate (mixed $angle)

toImage (line 83)

Render the line to an image Render the line to an image

access: public

void toImage (resource &$img, int $x, int $y, string $font)

int $x: X posotion to add.
int $y: Y posotion of the line.
string $font: The fontfile to use for rendering.
resource &$img: image $img The image to render to.