API Documentation

Text/Figlet.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Text_Figlet
version
$Id: Figlet.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Text_Figlet

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Text_Figlet
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Text_Figlet
Constants
SM_EQUAL
SM_LOWLINE
SM_HIERARCHY
SM_PAIR
SM_BIGX
SM_HARDBLANK
SM_KERN
SM_SMUSH
SMO_NO
SMO_YES
SMO_FORCE
JUSTIFICATION_LEFT
JUSTIFICATION_CENTER
JUSTIFICATION_RIGHT
DIRECTION_LEFT_TO_RIGHT
DIRECTION_RIGHT_TO_LEFT
FONTFILE_MAGIC_NUMBER
Properties
$_charList
$_fontLoaded
$_germanChars
$_outputWidth
$_hardBlank
$_charHeight
$_maxLength
$_smushMode
$_fontSmush
$_userSmush
$_handleParagraphs
$_justification
$_rightToLeft
$_smushOverride
$_fontOptions
$_previousCharWidth
$_currentCharWidth
$_outlineLength
$_outlineLengthLimit
$_inCharLine
$_inCharLineLength
$_inCharLineLengthLimit
$_currentChar
$_outputLine
$_output
$_skipOptions
Methods
__construct
setOptions
setConfig
setFont
setHandleParagraphs
setJustification
setOutputWidth
setRightToLeft
setSmushMode
render
_putString
_appendLine
_splitLine
_clearLine
_addChar
_getLetter
_smushAmount
_smushem
_loadFont
_setUsedSmush
_readMagic
_skipToEol
_loadChar
_uniOrd

Description

Zend_Text_Figlet is a PHP implementation of FIGlet

Constants

SM_EQUAL
jump to class

 SM_EQUAL = '0x01'

Smush2 layout modes

Details

value
0x01

SM_LOWLINE
jump to class

 SM_LOWLINE = '0x02'

Details

value
0x02

SM_HIERARCHY
jump to class

 SM_HIERARCHY = '0x04'

Details

value
0x04

SM_PAIR
jump to class

 SM_PAIR = '0x08'

Details

value
0x08

SM_BIGX
jump to class

 SM_BIGX = '0x10'

Details

value
0x10

SM_HARDBLANK
jump to class

 SM_HARDBLANK = '0x20'

Details

value
0x20

SM_KERN
jump to class

 SM_KERN = '0x40'

Details

value
0x40

SM_SMUSH
jump to class

 SM_SMUSH = '0x80'

Details

value
0x80

SMO_NO
jump to class

 SMO_NO = '0'

Smush mode override modes

Details

value
0

SMO_YES
jump to class

 SMO_YES = '1'

Details

value
1

SMO_FORCE
jump to class

 SMO_FORCE = '2'

Details

value
2

JUSTIFICATION_LEFT
jump to class

 JUSTIFICATION_LEFT = '0'

Justifications

Details

value
0

JUSTIFICATION_CENTER
jump to class

 JUSTIFICATION_CENTER = '1'

Details

value
1

JUSTIFICATION_RIGHT
jump to class

 JUSTIFICATION_RIGHT = '2'

Details

value
2

DIRECTION_LEFT_TO_RIGHT
jump to class

 DIRECTION_LEFT_TO_RIGHT = '0'

Write directions

Details

value
0

DIRECTION_RIGHT_TO_LEFT
jump to class

 DIRECTION_RIGHT_TO_LEFT = '1'

Details

value
1

FONTFILE_MAGIC_NUMBER
jump to class

 FONTFILE_MAGIC_NUMBER = 'flf2'

Magic fontfile number

Details

value
flf2

Properties

$_charHeight
jump to class

integer $_charHeight = ''

Height of the characters

Details

$_charHeight
integer
visibility
protected
default
final
false
static
false

$_charList
jump to class

array $_charList = 'array'

Array containing all characters of the current font

Details

$_charList
array
visibility
protected
default
array
final
false
static
false

$_currentChar
jump to class

array $_currentChar = 'null'

Current char

Details

$_currentChar
array
visibility
protected
default
null
final
false
static
false

$_currentCharWidth
jump to class

integer $_currentCharWidth = '0'

Current character width

Details

$_currentCharWidth
integer
visibility
protected
default
0
final
false
static
false

$_fontLoaded
jump to class

boolean $_fontLoaded = 'false'

Indicates if a font was loaded yet

Details

$_fontLoaded
boolean
visibility
protected
default
false
final
false
static
false

$_fontOptions
jump to class

array $_fontOptions = 'array'

Options of the current font

Details

$_fontOptions
array
visibility
protected
default
array
final
false
static
false

$_fontSmush
jump to class

integer $_fontSmush = '0'

Smush defined by the font

Details

$_fontSmush
integer
visibility
protected
default
0
final
false
static
false

$_germanChars
jump to class

array $_germanChars = 'array'

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

Details

$_germanChars
array
visibility
protected
default
array
final
false
static
false

$_handleParagraphs
jump to class

boolean $_handleParagraphs = 'false'

Wether to handle paragraphs || not

Details

$_handleParagraphs
boolean
visibility
protected
default
false
final
false
static
false

$_hardBlank
jump to class

string $_hardBlank = ''

Hard blank character

Details

$_hardBlank
string
visibility
protected
default
final
false
static
false

$_inCharLine
jump to class

string $_inCharLine = ''

In character line

Details

$_inCharLine
string
visibility
protected
default
final
false
static
false

$_inCharLineLength
jump to class

integer $_inCharLineLength = '0'

In character line length

Details

$_inCharLineLength
integer
visibility
protected
default
0
final
false
static
false

$_inCharLineLengthLimit
jump to class

integer $_inCharLineLengthLimit = '0'

Maximum in character line length

Details

$_inCharLineLengthLimit
integer
visibility
protected
default
0
final
false
static
false

$_justification
jump to class

integer $_justification = 'null'

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_*

Details

$_justification
integer
visibility
protected
default
null
final
false
static
false

$_maxLength
jump to class

integer $_maxLength = ''

Max length of any character

Details

$_maxLength
integer
visibility
protected
default
final
false
static
false

$_outlineLength
jump to class

integer $_outlineLength = '0'

Current outline length

Details

$_outlineLength
integer
visibility
protected
default
0
final
false
static
false

$_outlineLengthLimit
jump to class

integer $_outlineLengthLimit = '0'

Maxmimum outline length

Details

$_outlineLengthLimit
integer
visibility
protected
default
0
final
false
static
false

$_output
jump to class

string $_output = ''

Current output

Details

$_output
string
visibility
protected
default
final
false
static
false

$_outputLine
jump to class

array $_outputLine = ''

Current output line

Details

$_outputLine
array
visibility
protected
default
final
false
static
false

$_outputWidth
jump to class

integer $_outputWidth = '80'

Output width, defaults to 80.

Details

$_outputWidth
integer
visibility
protected
default
80
final
false
static
false

$_previousCharWidth
jump to class

integer $_previousCharWidth = '0'

Previous character width

Details

$_previousCharWidth
integer
visibility
protected
default
0
final
false
static
false

$_rightToLeft
jump to class

integer $_rightToLeft = 'null'

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_*

Details

$_rightToLeft
integer
visibility
protected
default
null
final
false
static
false

$_skipOptions
jump to class

array $_skipOptions = 'array'

Option keys to skip when calling setOptions()

Details

$_skipOptions
array
visibility
protected
default
array
final
false
static
false

$_smushMode
jump to class

integer $_smushMode = '0'

Smush mode

Details

$_smushMode
integer
visibility
protected
default
0
final
false
static
false

$_smushOverride
jump to class

integer $_smushOverride = '0'

Override font file smush layout

Details

$_smushOverride
integer
visibility
protected
default
0
final
false
static
false

$_userSmush
jump to class

integer $_userSmush = '0'

Smush defined by the user

Details

$_userSmush
integer
visibility
protected
default
0
final
false
static
false

Methods

__construct
jump to class

__construct( array|Zend_Config $options = null ) :

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.

Arguments
$options
arrayZend_Config
Options for the output
Details
visibility
public
final
false
static
false

_addChar
jump to class

_addChar( string $char ) : boolean

Attempts to add the given character onto the end of the current line.

Returns true if this can be done, false otherwise.

Arguments
$char
string
Character which to add to the output
Output
boolean
Details
visibility
protected
final
false
static
false

_appendLine
jump to class

_appendLine( ) : void

Appends the current line to the output

Details
visibility
protected
final
false
static
false

_clearLine
jump to class

_clearLine( ) : void

Clears the current line

Details
visibility
protected
final
false
static
false

_getLetter
jump to class

_getLetter( string $char ) : void

Gets the requested character and sets current and previous char width.

Arguments
$char
string
The character from which to get the letter of
Details
visibility
protected
final
false
static
false

_loadChar
jump to class

_loadChar( resource $fp ) : array

Load a single character from the font file

Arguments
$fp
resource
File pointer to the font file
Output
array
Details
visibility
protected
final
false
static
false

_loadFont
jump to class

_loadFont( string $fontFile ) : void

Load the specified font

Arguments
$fontFile
string
Font file to load
Details
visibility
protected
final
false
static
false
throws
When font file was not found
throws
When GZIP library is required but not found
throws
When font file is not readable

_putString
jump to class

_putString( string $string ) : void

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.

Arguments
$string
string
The string to add to the output
Details
visibility
protected
final
false
static
false

_readMagic
jump to class

_readMagic( resource $fp ) : string

Reads a four-character magic string from a stream

Arguments
$fp
resource
File pointer to the font file
Output
string
Details
visibility
protected
final
false
static
false

_setUsedSmush
jump to class

_setUsedSmush( ) : void

Set the used smush mode, according to smush override, user smsush and font smush.

Details
visibility
protected
final
false
static
false

_skipToEol
jump to class

_skipToEol( resource $fp ) : void

Skip a stream to the end of line

Arguments
$fp
resource
File pointer to the font file
Details
visibility
protected
final
false
static
false

_smushAmount
jump to class

_smushAmount( ) : integer

Returns the maximum amount that the current character can be smushed into the current line.

Output
integer
Details
visibility
protected
final
false
static
false

_smushem
jump to class

_smushem( string $leftChar, string $rightChar ) : string

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

Arguments
$leftChar
string
Left character to smush
$rightChar
string
Right character to smush
Output
string
Details
visibility
protected
final
false
static
false

_splitLine
jump to class

_splitLine( ) : void

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.

Details
visibility
protected
final
false
static
false

_uniOrd
jump to class

_uniOrd( string $c ) : integer

Unicode compatible ord() method

Arguments
$c
string
The char to get the value from
Output
integer
Details
visibility
protected
final
false
static
false

render
jump to class

render( string $text, string $encoding = UTF-8 ) : string

Render a FIGlet text

Arguments
$text
string
Text to convert to a figlet text
$encoding
string
Encoding of the input string
Output
string
Details
visibility
public
final
false
static
false
throws
When $text is not a string
throws
When $text it not properly encoded

setConfig
jump to class

setConfig( Zend_Config $config ) : Zend_Text_Figlet

Set options from config object

Arguments
$config
Zend_Config
Configuration for Zend_Text_Figlet
Output
Zend_Text_Figlet
Details
visibility
public
final
false
static
false

setFont
jump to class

setFont( string $font ) : Zend_Text_Figlet

Set a font to use

Arguments
$font
string
Path to the font
Output
Zend_Text_Figlet
Details
visibility
public
final
false
static
false

setHandleParagraphs
jump to class

setHandleParagraphs( boolean $handleParagraphs ) : Zend_Text_Figlet

Set handling of paragraphs

Arguments
$handleParagraphs
boolean
Wether to handle paragraphs or not
Output
Zend_Text_Figlet
Details
visibility
public
final
false
static
false

setJustification
jump to class

setJustification( integer $justification ) : Zend_Text_Figlet

Set the justification. 0 stands for left aligned, 1 for centered and 2 for right aligned.

Arguments
$justification
integer
Justification of the output text
Output
Zend_Text_Figlet
Details
visibility
public
final
false
static
false

setOptions
jump to class

setOptions( array $options ) : Zend_Text_Figlet

Set options from array

Arguments
$options
array
Configuration for Zend_Text_Figlet
Output
Zend_Text_Figlet
Details
visibility
public
final
false
static
false

setOutputWidth
jump to class

setOutputWidth( integer $outputWidth ) : Zend_Text_Figlet

Set the output width

Arguments
$outputWidth
integer
Output with which should be used for word wrapping and justification
Output
Zend_Text_Figlet
Details
visibility
public
final
false
static
false

setRightToLeft
jump to class

setRightToLeft( integer $rightToLeft ) : Zend_Text_Figlet

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.

Arguments
$rightToLeft
integer
Right-to-left mode
Output
Zend_Text_Figlet
Details
visibility
public
final
false
static
false

setSmushMode
jump to class

setSmushMode( integer $smushMode ) : Zend_Text_Figlet

Set the smush mode.

Use one of the constants of Zend_Text_Figlet::SM_*, you may combine them.

Arguments
$smushMode
integer
Smush mode to use for generating text
Output
Zend_Text_Figlet
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.