Docs For Class Text_TeXHyphen

Text_TeXHyphen_WordCache Text_TeXHyphen_WordCache(
)

Constructor of a Text_TeXHyphen_WordCache object.

At contruction of a Text_TeXHyphen_WordCache object the error stack will referenced to the 'Text_TeXHyphen' error stack.

[ Top ]

boolean add(
string
$word, array
$syls)

Adds a word and its syllables to the cache.

Overridden in child classes as:

Text_TeXHyphen_WordCache_SimpleHash::add(): Adds a word and its syllables to the cache.

string	`$word`	—	Word, which syllables should stored.
array	`$syls`	—	Array of strings, which contains of the syllables of the $word.

[ Top ]

Text_TeXHyphen_WordCache|false &factory(
string
$type, [array
$options = array()])

Factory for creating a word.

Return: Reference to an object of type Text_TeXHyphen_WordCache or a subclass of it, if successful or false on error.
Access: public

Overridden in child classes as:

Text_TeXHyphen_WordCache_SimpleHash::factory(): Factory for creating a word.

string	`$type`	—	Name of the word cache implementation.
array	`$options`	—	Options for word cache implementation.

[ Top ]

array|false getSyllables(
string
$word)

Gets the syllables of a word, if found in cache.

Overridden in child classes as:

Text_TeXHyphen_WordCache_SimpleHash::getSyllables(): Gets the syllables of a word, if found in cache.

string $word — Word of which the syllables should got.

[ Top ]

Class: Text_TeXHyphen_WordCache