Docs For Class Text_TeXHyphen_WordCache

boolean add(
string
$word, array
$syls)

Adds a word and its syllables to the cache.

Return: true, if the $word could added to the cache otherwise false.

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

Parameters:

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

[ Top ]

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

Factory for creating a word.

Return: Reference to a object of type Text_TeXHyphen_WordCache_SimpleHash, a subclass of Text_TeXHyphen_WordCache, or false on error.
Access: public

Overrides Text_TeXHyphen_WordCache::factory() (Factory for creating a word.)

Parameters:

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

[ Top ]

array|false getSyllables(
string
$word)

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

Return: Array of string or false, if $word isn't found.
Access: public

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

Parameters:

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

[ Top ]

string|false serialize(
[boolean
$compression = true])

Serializes the current state of the hash and returns the data.

Takes the current hash and passes to serialize(). The returned string, will compressed by gzcompress(), if $compression is true.

Return: the (compressed) serialized hash data or false on error.
Access: public

Parameters:

boolean $compression — Decides, if the serialized hash is compressed.

[ Top ]

boolean unserialize(
string
$data, [boolean
$compression = true])

Unserializes the hash from the data.

Takes the $data and uncompresses the serialized hash, if $compression is true. The serialized hash will passed to unserialize() and the hash set to the returned array.

Return: true, if successful otherwise false.
Access: public

Parameters:

string	`$data`	—	(compressed) serialzed hash data.
boolean	`$compression`	—	Decides, if the data is uncompressed before unserialisation of the data.

[ Top ]

Class: Text_TeXHyphen_WordCache_SimpleHash

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class: Text_TeXHyphen_WordCache

Class Details

Method Detail

add [line 117]

Parameters:

factory [line 63]

Parameters:

getSyllables [line 92]

Parameters:

serialize [line 142]

Parameters:

unserialize [line 176]

Parameters: