Class: Text_TeXHyphen_Pattern

array|false createHyphenValues( string $patternStr)

Creates the hyphen values from a TeX pattern string.

The hyphen values are an array of intergers, which values the desireability of a hyphen between two characters.

Parameters:

string|false createKey( string $patternStr)

Creates the key from a TeX pattern string

The key contains only of the characters and dots of the TeX pattern string. False will return, if the resulting key contains only of whitespace characters.

Parameters:

Text_TeXHyphen_Pattern|false &factory( string $patternStr)

Factory for creating a Text_TeXHyphen_Pattern object from a TeX pattern string.

The factory initalizes a new Text_TeXHyphen_Pattern object, creates the key and the hyphen values. If the pattern string didn't meet the criterias of isValid(), false will returned. This also occurs, if the creation of the key or the hyphen values return an error.

Parameters:

integer|false getHyphenValue( integer $index)

Gets the hyphen value at a passed index.

False will return, if the hyphen value isn't set or the value isn't an integer.

Parameters:

array|false getHyphenValues( )

Gets the hyphen values of the pattern.

string|false getKey( )

Gets the key of the pattern.

If the key contains only of whitspace characters false will returned.

string|false getPattern( )

Gets the TeX pattern string.

boolean isValid( string $patternStr)

Validates a pattern string against some special criterias.

The pattern string have to meet following criterias:

• not empty
• not only a combination of whitepace charaters, digits or dots
• no whitespace character at all
• no dots inside the string

All other validation for a correct pattern string have to take place outside the class. This decision was made, because different languages could have different characters allowed in pattern strings.

Parameters:

boolean setPattern( string $patternStr)

Sets the TeX pattern string.

Whitespace charaters at the start and end will trimed. The key and hyphen values are created automatic. False will returned, if the pattern string is invalid or the key and hyphen values creation fail, otherwise true.

Parameters: