|
|
| (12 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_Hyphen''.
| | #REDIRECT [[Class: I2CE_Hyphen (4.1.7)]] |
| *Location: Part of the module [[TextLayout Tools Module List#textlayout|textlayout]] in the package [https://launchpad.net/textlayout TextLayout Tools]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L31 lib/I2CE_Hyphen.php] on line 31
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| PHP script implement Knuth's and Liang's hyphenation algorithm as described in http://lingucomponent.openoffice.org/hyphenator.html In particular it uses the 'mashed up' dictionary files Note: Internally, by default, all strings are encoded as UTF-8. This is highly recommended to enable the unicode preg to work quickly (without having to covert to UTF=8 and then back). Note: Does not (yet) support the non-standard hyphenation of hungarian, swedish, etc.
| |
| ==Variables==
| |
| ===$enc===
| |
| protected @var I2CE_Encoding $enc the encoding used for internal storage of strings
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L36 textlayout/lib/I2CE_Hyphen.php] on line 36
| |
| *Type: protected $enc
| |
| | |
| ===$patterns===
| |
| An associative array contating the hyphenation patterns
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L126 textlayout/lib/I2CE_Hyphen.php] on line 126
| |
| *Type: protected $patterns
| |
| | |
| ===$trans===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L127 textlayout/lib/I2CE_Hyphen.php] on line 127
| |
| *Type: protected $trans
| |
| | |
| ==Methods==
| |
| ===HyphenateWord()===
| |
| Hyphenates a word according to the loaded dictionary
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L139 textlayout/lib/I2CE_Hyphen.php] on line 139
| |
| *Signature: public function HyphenateWord($word,$supress)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $word <br/>the word to be hyphenated WARNING the word is assumed to be only letters. if you need something more general see getWordParts()
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php bool ] $supress <br/>true (default)to suppress hyphenation points at the beginning/end of a word.
| |
| ***Default Value: true
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of int containing the hyphenation points. the hyphenation points are the offsets for begining of each subword. of course, 0 is a hyphenation point.
| |
| ===LoadHyphenDictionary()===
| |
| Load the hyphenation dictionary. The file is expected to be a 'mashed up' version of a .tex hyphenation dictionary geneareted by using substrings.pl as in the stand-along hyphenation code of http://lingucomponent.openoffice.org/hyphenator.html
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L55 textlayout/lib/I2CE_Hyphen.php] on line 55
| |
| *Signature: public function LoadHyphenDictionary($file)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $file <br/>file containing the dictionary
| |
| ===Visualize()===
| |
| Visualize a hyphenation for a word
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L246 textlayout/lib/I2CE_Hyphen.php] on line 246
| |
| *Signature: public function Visualize($word,$supress)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $word <br/>the word that is to be hyphenated WARNING the word is assumed to have no whitespace or periods and to be only one word no digits or other special characters (unless they are already in your hypehnation dictionary)
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php bool ] $supress <br/>true (default)to suppress hyphenation points at the beginning/end of a word.
| |
| ***Default Value: TRUE
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>the hyphenated word
| |
| ===__construct()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L42 textlayout/lib/I2CE_Hyphen.php] on line 42
| |
| *Signature: public function __construct($enc)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Encoding | I2CE_Encoding]] $enc <br/>specify the encoding the internal storage of this hyphenation dictionaty to the specified encoding.
| |
| ===getWordParts()===
| |
| Get the parts of a word which breaks along hyphenation points or any non-letter.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Hyphen.php#L284 textlayout/lib/I2CE_Hyphen.php] on line 284
| |
| *Signature: public function getWordParts($word,$supress)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $word <br/>the word we wish to break up
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php bool ] $supress <br/>true (default)to suppress hyphenation points at the beginning/end of a word.
| |
| ***Default Value: true
| |
| *Returns: an<br/>the associative array has a string 'Subword' which tells what the subword is, the int 'Offset' tells where the subword started, the int 'Length' the length of the subword, and the boolean 'IsLetter' which tells us if the subword is a composed of letters (by the Unicode convention) or not.
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
