Docs For Class Text_TeXHyphen_PatternDB

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

Factory for creating a Text_TeXHyphen_Pattern object hash as pattern database.

The type have to be 'objecthash', otherwise false will returned. For the creation extists two modes (options['mode']):

build, creates a whole new hash from an array of TeX pattern strings. For the initialize function the option 'onlyKeys' and 'sort' can be passed.
load, loads a serialized hash from a file specified by the option 'fileName'. Additional the option 'compression' for the unserialize() can be passed.

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

Overrides Text_TeXHyphen_PatternDB::factory() (Factory for creating a pattern database.)

Parameters:

string	`$type`	—	Name of the pattern database implementation, must 'objecthash'.
array	`$options`	—	Options for the pattern retrieving.

[ Top ]

Text_TeXHyphen_Pattern|false &getPattern(
string
$key)

Gets the Text_TeXHyphen_Pattern object specified by the $key, if it exists in the pattern database.

Return: Reference to a Text_TeXHyphen_Pattern object if successful or false if the pattern isn't found.
See: Text_TeXHyphen_Pattern
Access: public

Overrides Text_TeXHyphen_PatternDB::getPattern() (Gets the Text_TeXHyphen_Pattern object specified by the $key, if it exists in the pattern database.)

Parameters:

string $key — String by which the pattern should be identified in the hash.

[ Top ]

boolean initialize(
array
$patternStrArr, [boolean
$onlyKeys = false], [boolean
$sort = true])

Initializes the Text_TeXHyphen_Pattern object hash.

The $patternStrArr contains the TeX pattern strings from which the Text_TeXHyphen_Pattern will created. If $onlyKey is true, only the key of the pattern is created and the TeX pattern string is included in the hash. The Text_TeXHyphen_Pattern will created on demand by getPattern(). If $sort is true the hash will after initilization sorted by ksort().

Return: true, if successful otherwise false
See: Text_TeXHyphen_Pattern::createKey()
See: Text_TeXHyphen_PatternDB_ObjectHash::getPattern()
Access: public

Parameters:

array	`$patternStrArr`	—	Array of TeX pattern strings.
boolean	`$onlyKeys`	—	Decides, if only the patterns keys are generated and the Text_TeXHyphen_Pattern on demand.
boolean	`$sort`	—	Decides, if the hash is sorted at the end of the initialization process.

[ Top ]

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

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

Takes the current pattern hash and passes to serialize(). The returned string, will compressed by gzcompress(), if $compression is true. If the $onlyKeys=true option of the inizialize function is used the missing Text_TeXHyphen_Pattern object will not created before serialization.

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

Parameters:

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

[ Top ]

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

Unserializes the pattern hash from the data.

Takes the $data and uncompresses the serialized pattern hash, if $compression is true. The serialized pattern hash will passed to unserialize() and the pattern 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_PatternDB_ObjectHash

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class: Text_TeXHyphen_PatternDB

Class Details

Method Detail

factory [line 78]

Parameters:

getPattern [line 208]

Parameters:

initialize [line 258]

Parameters:

serialize [line 342]

Parameters:

unserialize [line 377]

Parameters: