|
|
| (13 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_Encoding''.
| | #REDIRECT [[Class: I2CE_Encoding (4.1.12)]] |
| *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_Encoding.php#L10 lib/I2CE_Encoding.php] on line 10
| |
| helper library to store/look-up glyphnames associated to a character code.
| |
| ==Variables==
| |
| ===$glyph_names===
| |
| protected @var $glyph_names an array of arrays with values glyph names and keys unicode codepoints the first index of the array is the encoding type
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L17 textlayout/lib/I2CE_Encoding.php] on line 17
| |
| *Type: protected $glyph_names
| |
| | |
| ===$encoding===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L23 textlayout/lib/I2CE_Encoding.php] on line 23
| |
| *Type: protected $encoding
| |
| | |
| ===$mb_encoding===
| |
| protected @var string $unicode_encoding
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L28 textlayout/lib/I2CE_Encoding.php] on line 28
| |
| *Type: protected $mb_encoding
| |
| | |
| ===$useMB===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L59 textlayout/lib/I2CE_Encoding.php] on line 59
| |
| *Type: protected $useMB
| |
| | |
| ===$fix===
| |
| Some common incorrect glyph names
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L194 textlayout/lib/I2CE_Encoding.php] on line 194
| |
| *Type: static public fix $fix
| |
| | |
| ==Methods==
| |
| ===UnicodeFromCharactercode()===
| |
| get the multibyte character associated to a character code
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L100 textlayout/lib/I2CE_Encoding.php] on line 100
| |
| *Signature: public function UnicodeFromCharactercode($cc)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $cc <br/>the character code
| |
| *Returns: [http://www.php.net/manual/en/language.types.integer.php int ]<br/>unicode codepoint
| |
| ===UnicodeFromGlyphname()===
| |
| get the multibyte character associated to a glyphname
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L86 textlayout/lib/I2CE_Encoding.php] on line 86
| |
| *Signature: public function UnicodeFromGlyphname($gn)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $gn <br/>the glyp hname
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>n character in the selected encoding
| |
| ===UnicodeToCharacterCode()===
| |
| get the character code to a unicode codepoint
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L108 textlayout/lib/I2CE_Encoding.php] on line 108
| |
| *Signature: public function UnicodeToCharacterCode($in)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $in
| |
| ===UnicodeToGlyphname()===
| |
| get the glpyh name associated to to a unicode codepoint
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L116 textlayout/lib/I2CE_Encoding.php] on line 116
| |
| *Signature: public function UnicodeToGlyphname($in)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $in
| |
| ===__construct()===
| |
| @param string $encoding_type -- set to the encoding used needs to be one of PHP multibyte strings encodings
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L35 textlayout/lib/I2CE_Encoding.php] on line 35
| |
| *Signature: public function __construct($mb_encoding)
| |
| *Parameters:
| |
| **$mb_encoding
| |
| ===changeGlyphNames()===
| |
| Change the glyph names @param $names an associative array with the new value being the value and the old value being the key
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L173 textlayout/lib/I2CE_Encoding.php] on line 173
| |
| *Signature: public function changeGlyphNames($names)
| |
| *Parameters:
| |
| **$names
| |
| ===fixEuro()===
| |
| Make sure U+20AC has the glyphname euro if it exists in this encoding
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L187 textlayout/lib/I2CE_Encoding.php] on line 187
| |
| *Signature: public function fixEuro()
| |
| ===getEncodingType()===
| |
| Get the unicode encoding to use
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L74 textlayout/lib/I2CE_Encoding.php] on line 74
| |
| *Signature: public function getEncodingType()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>$encoding with values:
| |
| ===readMap()===
| |
| Read in a character encoding from a file
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L148 textlayout/lib/I2CE_Encoding.php] on line 148
| |
| *Signature: public function readMap($enc_file)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $enc_file <br/>the file containing the character encoded exmaples are cp1250.map ISO-8859-1.map etc. this function has been graciously stolen from makefont.php
| |
| ===setCharacterCode()===
| |
| Set the character code assoicated to a unicode code point
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L136 textlayout/lib/I2CE_Encoding.php] on line 136
| |
| *Signature: public function setCharacterCode($cp,$cc)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $cp <br/>the unicode code point
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $cc <br/>the character code (either int or a character)
| |
| ===setEncodingType()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L44 textlayout/lib/I2CE_Encoding.php] on line 44
| |
| *Signature: protected function setEncodingType($mb_encoding)
| |
| *Parameters:
| |
| **$mb_encoding
| |
| ===setGlyphname()===
| |
| Set the gylph name of a character
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L127 textlayout/lib/I2CE_Encoding.php] on line 127
| |
| *Signature: public function setGlyphname($cp,$gn)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $cp <br/>the unicode code point
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $gn <br/>the glyphname
| |
| ===useMB()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.2-release/annotate/head:/lib/I2CE_Encoding.php#L65 textlayout/lib/I2CE_Encoding.php] on line 65
| |
| *Signature: public function useMB()
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
