Zend_Text_Figlet
Zend_Text_Figlet is a PHP implementation of FIGlet
Located in /Text/Figlet.php (line 30)
integer
$_charHeight
(line 117)
Height of the characters
array
$_charList
= array() (line 74)
Array containing all characters of the current font
array
$_currentChar
= null (line 242)
Current char
integer
$_currentCharWidth
= 0 (line 200)
Current character width
boolean
$_fontLoaded
= false (line 81)
Indicates if a font was loaded yet
array
$_fontOptions
= array() (line 186)
Options of the current font
integer
$_fontSmush
= 0 (line 138)
Smush defined by the font
array
$_germanChars
= array(196, 214, 220, 228, 246, 252, 223) (line 96)
Latin-1 codes for German letters, respectively:
LATIN CAPITAL LETTER A WITH DIAERESIS = A-umlaut LATIN CAPITAL LETTER O WITH DIAERESIS = O-umlaut LATIN CAPITAL LETTER U WITH DIAERESIS = U-umlaut LATIN SMALL LETTER A WITH DIAERESIS = a-umlaut LATIN SMALL LETTER O WITH DIAERESIS = o-umlaut LATIN SMALL LETTER U WITH DIAERESIS = u-umlaut LATIN SMALL LETTER SHARP S = ess-zed
boolean
$_handleParagraphs
= false (line 152)
Wether to handle paragraphs || not
string
$_hardBlank
(line 110)
Hard blank character
string
$_inCharLine
(line 221)
In character line
integer
$_inCharLineLength
= 0 (line 228)
In character line length
integer
$_inCharLineLengthLimit
= 0 (line 235)
Maximum in character line length
integer
$_justification
= null (line 162)
Justification for the text, according to $_outputWidth
For using font default, this parameter should be null, else one of the values of Zend_Text_Figlet::JUSTIFICATION_*
integer
$_maxLength
(line 124)
Max length of any character
integer
$_outlineLength
= 0 (line 207)
Current outline length
integer
$_outlineLengthLimit
= 0 (line 214)
Maxmimum outline length
string
$_output
(line 256)
Current output
array
$_outputLine
(line 249)
Current output line
integer
$_outputWidth
= 80 (line 103)
Output width, defaults to 80.
integer
$_previousCharWidth
= 0 (line 193)
Previous character width
integer
$_rightToLeft
= null (line 172)
Direction of text-writing, namely right to left
For using font default, this parameter should be null, else one of the values of Zend_Text_Figlet::DIRECTION_*
array
$_skipOptions
= array('options',
'config',
) (line 263)
Option keys to skip when calling setOptions()
integer
$_smushMode
= 0 (line 131)
Smush mode
integer
$_smushOverride
= 0 (line 179)
Override font file smush layout
integer
$_userSmush
= 0 (line 145)
Smush defined by the user
Constructor __construct (line 276)
Instantiate the FIGlet with a specific font. If no font is given, the standard font is used. You can also supply multiple options via the $options variable, which can either be an array or an instance of Zend_Config.
- array|Zend_Config $options: Options for the output
render (line 427)
Render a FIGlet text
- string $text: Text to convert to a figlet text
- string $encoding: Encoding of the input string
setConfig (line 318)
Set options from config object
- Zend_Config $config: Configuration for Zend_Text_Figlet
setFont (line 329)
Set a font to use
- string $font: Path to the font
setHandleParagraphs (line 341)
Set handling of paragraphs
- boolean $handleParagraphs: Wether to handle paragraphs or not
setJustification (line 354)
Set the justification. 0 stands for left aligned, 1 for centered and 2 for right aligned.
- integer $justification: Justification of the output text
setOptions (line 297)
Set options from array
- array $options: Configuration for Zend_Text_Figlet
setOutputWidth (line 367)
Set the output width
- integer $outputWidth: Output with which should be used for word wrapping and justification
setRightToLeft (line 381)
Set right to left mode. For writing from left to right, use Zend_Text_Figlet::DIRECTION_LEFT_TO_RIGHT. For writing from right to left, use Zend_Text_Figlet::DIRECTION_RIGHT_TO_LEFT.
- integer $rightToLeft: Right-to-left mode
setSmushMode (line 395)
Set the smush mode.
Use one of the constants of Zend_Text_Figlet::SM_*, you may combine them.
- integer $smushMode: Smush mode to use for generating text
_addChar (line 658)
Attempts to add the given character onto the end of the current line.
Returns true if this can be done, false otherwise.
- string $char: Character which to add to the output
_appendLine (line 580)
Appends the current line to the output
_clearLine (line 641)
Clears the current line
_getLetter (line 716)
Gets the requested character and sets current and previous char width.
- string $char: The character from which to get the letter of
_loadChar (line 1184)
Load a single character from the font file
- resource $fp: File pointer to the font file
_loadFont (line 967)
Load the specified font
- string $fontFile: Font file to load
_putString (line 554)
Puts the given string, substituting blanks for hardblanks. If outputWidth
is 1, puts the entire string; otherwise puts at most outputWidth - 1 characters. Puts a newline at the end of the string. The string is left- justified, centered or right-justified (taking outputWidth as the screen width) if justification is 0, 1 or 2 respectively.
- string $string: The string to add to the output
_readMagic (line 1139)
Reads a four-character magic string from a stream
- resource $fp: File pointer to the font file
_setUsedSmush (line 1122)
Set the used smush mode, according to smush override, user smsush and font smush.
_skipToEol (line 1156)
Skip a stream to the end of line
- resource $fp: File pointer to the font file
_smushAmount (line 733)
Returns the maximum amount that the current character can be smushed into the current line.
_smushem (line 842)
Given two characters, attempts to smush them into one, according to the current smushmode. Returns smushed character or false if no smushing can be done.
Smushmode values are sum of following (all values smush blanks):
1: Smush equal chars (not hardblanks) 2: Smush '_' with any char in hierarchy below 4: hierarchy: "|", "/\", "[]", "{}", "()", "<>" Each class in hier. can be replaced by later class. 8: [ + ] -> |, { + } -> |, ( + ) -> | 16: / + \ -> X, > + < -> X (only in that order) 32: hardblank + hardblank -> hardblank
- string $leftChar: Left character to smush
- string $rightChar: Right character to smush
_splitLine (line 596)
Splits inCharLine at the last word break (bunch of consecutive blanks).
Makes a new line out of the first part and appends it using appendLine(). Makes a new line out of the second part and returns.
_uniOrd (line 1211)
Unicode compatible ord() method
- string $c: The char to get the value from
DIRECTION_LEFT_TO_RIGHT
= 0
(line 61)
Write directions
DIRECTION_RIGHT_TO_LEFT
= 1
(line 62)
FONTFILE_MAGIC_NUMBER
= 'flf2'
(line 67)
Magic fontfile number
JUSTIFICATION_CENTER
= 1
(line 55)
JUSTIFICATION_LEFT
= 0
(line 54)
Justifications
JUSTIFICATION_RIGHT
= 2
(line 56)
SMO_FORCE
= 2
(line 49)
SMO_NO
= 0
(line 47)
Smush mode override modes
SMO_YES
= 1
(line 48)
SM_BIGX
= 0x10
(line 39)
SM_EQUAL
= 0x01
(line 35)
Smush2 layout modes
SM_HARDBLANK
= 0x20
(line 40)
SM_HIERARCHY
= 0x04
(line 37)
SM_KERN
= 0x40
(line 41)
SM_LOWLINE
= 0x02
(line 36)
SM_PAIR
= 0x08
(line 38)
SM_SMUSH
= 0x80
(line 42)
Documentation generated on Mon, 21 Jun 2010 15:23:05 -0400 by phpDocumentor 1.4.3