Text/Figlet.php

Show:

inherited

Classes
- \Zend_Text_Figlet

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Text_Figlet
Version: $Id$

\Zend_Text_Figlet
jump to top

Package: Zend_Text_Figlet

Zend_Text_Figlet is a PHP implementation of FIGlet

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                SM_EQUAL
                = 1

Smush2 layout modes

 
                SM_LOWLINE
                = 2

 
                SM_HIERARCHY
                = 4

 
                SM_PAIR
                = 8

 
                SM_BIGX
                = 16

 
                SM_HARDBLANK
                = 32

 
                SM_KERN
                = 64

 
                SM_SMUSH
                = 128

 
                SMO_NO
                = 0

Smush mode override modes

 
                SMO_YES
                = 1

 
                SMO_FORCE
                = 2

 
                JUSTIFICATION_LEFT
                = 0

Justifications

 
                JUSTIFICATION_CENTER
                = 1

 
                JUSTIFICATION_RIGHT
                = 2

 
                DIRECTION_LEFT_TO_RIGHT
                = 0

Write directions

 
                DIRECTION_RIGHT_TO_LEFT
                = 1

 
                FONTFILE_MAGIC_NUMBER
                = 'flf2'

Magic fontfile number

Properties

integer $_charHeight

Height of the characters

Details

Type: integer

array $_charList = array()

Array containing all characters of the current font

Default valuearray()Details

Type: array

array $_currentChar = null

Current char

Default valuenullDetails

Type: array

integer $_currentCharWidth = 0

Current character width

Default value0Details

Type: integer

boolean $_fontLoaded = false

Indicates if a font was loaded yet

Default valuefalseDetails

Type: boolean

array $_fontOptions = array()

Options of the current font

Default valuearray()Details

Type: array

integer $_fontSmush = 0

Smush defined by the font

Default value0Details

Type: integer

array $_germanChars = array(196, 214, 220, 228, 246, 252, 223)

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

Default valuearray(196, 214, 220, 228, 246, 252, 223)Details

Type: array

boolean $_handleParagraphs = false

Wether to handle paragraphs || not

Default valuefalseDetails

Type: boolean

string $_hardBlank

Hard blank character

Details

Type: string

string $_inCharLine

In character line

Details

Type: string

integer $_inCharLineLength = 0

In character line length

Default value0Details

Type: integer

integer $_inCharLineLengthLimit = 0

Maximum in character line length

Default value0Details

Type: integer

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

Default valuenullDetails

Type: integer

integer $_maxLength

Max length of any character

Details

Type: integer

integer $_outlineLength = 0

Current outline length

Default value0Details

Type: integer

integer $_outlineLengthLimit = 0

Maxmimum outline length

Default value0Details

Type: integer

string $_output

Current output

Details

Type: string

array $_outputLine

Current output line

Details

Type: array

integer $_outputWidth = 80

Output width, defaults to 80.

Default value80Details

Type: integer

integer $_previousCharWidth = 0

Previous character width

Default value0Details

Type: integer

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

Default valuenullDetails

Type: integer

array $_skipOptions = array('options', 'config')

Option keys to skip when calling setOptions()

Default valuearray('options', 'config')Details

Type: array

integer $_smushMode = 0

Smush mode

Default value0Details

Type: integer

integer $_smushOverride = 0

Override font file smush layout

Default value0Details

Type: integer

integer $_userSmush = 0

Smush defined by the user

Default value0Details

Type: integer

Methods

__construct(array | \Zend_Config $options = null) : void

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.

Parameters

Name	Type	Description
$options	array \| \Zend_Config	Options for the output

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

Parameters

Name	Type	Description
$char	string	Character which to add to the output

Returns

Type	Description
boolean

_appendLine() : void

Appends the current line to the output

_clearLine() : void

Clears the current line

_getLetter(string $char) : void

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

Parameters

Name	Type	Description
$char	string	The character from which to get the letter of

_loadChar(resource $fp) : array

Load a single character from the font file

Parameters

Name	Type	Description
$fp	resource	File pointer to the font file

Returns

Type	Description
array

_loadFont(string $fontFile) : void

Load the specified font

Parameters

Name	Type	Description
$fontFile	string	Font file to load

Throws

Exception	Description
\Zend_Text_Figlet_Exception	When font file was not found
\Zend_Text_Figlet_Exception	When GZIP library is required but not found
\Zend_Text_Figlet_Exception	When font file is not readable

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

Parameters

Name	Type	Description
$string	string	The string to add to the output

_readMagic(resource $fp) : string

Reads a four-character magic string from a stream

Parameters

Name	Type	Description
$fp	resource	File pointer to the font file

Returns

Type	Description
string

_setUsedSmush() : void

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

_skipToEol(resource $fp) : void

Skip a stream to the end of line

Parameters

Name	Type	Description
$fp	resource	File pointer to the font file

_smushAmount() : integer

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

Returns

Type	Description
integer

_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

Parameters

Name	Type	Description
$leftChar	string	Left character to smush
$rightChar	string	Right character to smush

Returns

Type	Description
string

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

_uniOrd(string $c) : integer

Unicode compatible ord() method

Parameters

Name	Type	Description
$c	string	The char to get the value from

Returns

Type	Description
integer

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

Render a FIGlet text

Parameters

Name	Type	Description
$text	string	Text to convert to a figlet text
$encoding	string	Encoding of the input string

Returns

Type	Description
string

Throws

Exception	Description
\InvalidArgumentException	When $text is not a string
\Zend_Text_Figlet_Exception	When $text it not properly encoded

setConfig(\Zend_Config $config) : \Zend_Text_Figlet

Set options from config object

Parameters

Name	Type	Description
$config	\Zend_Config	Configuration for Zend_Text_Figlet

Returns

Type	Description
\Zend_Text_Figlet

setFont(string $font) : \Zend_Text_Figlet

Set a font to use

Parameters

Name	Type	Description
$font	string	Path to the font

Returns

Type	Description
\Zend_Text_Figlet

setHandleParagraphs(boolean $handleParagraphs) : \Zend_Text_Figlet

Set handling of paragraphs

Parameters

Name	Type	Description
$handleParagraphs	boolean	Wether to handle paragraphs or not

Returns

Type	Description
\Zend_Text_Figlet

setJustification(integer $justification) : \Zend_Text_Figlet

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

Parameters

Name	Type	Description
$justification	integer	Justification of the output text

Returns

Type	Description
\Zend_Text_Figlet

setOptions(array $options) : \Zend_Text_Figlet

Set options from array

Parameters

Name	Type	Description
$options	array	Configuration for Zend_Text_Figlet

Returns

Type	Description
\Zend_Text_Figlet

setOutputWidth(integer $outputWidth) : \Zend_Text_Figlet

Set the output width

Parameters

Name	Type	Description
$outputWidth	integer	Output with which should be used for word wrapping and justification

Returns

Type	Description
\Zend_Text_Figlet

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.

Parameters

Name	Type	Description
$rightToLeft	integer	Right-to-left mode

Returns

Type	Description
\Zend_Text_Figlet

setSmushMode(integer $smushMode) : \Zend_Text_Figlet

Set the smush mode.

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

Parameters

Name	Type	Description
$smushMode	integer	Smush mode to use for generating text

Returns

Type	Description
\Zend_Text_Figlet

Text/Figlet.php

\Zend_Text_Figletjump to top

Constants

Properties

Methods

\Zend_Text_Figlet
jump to top