Class: I2CE Encoding: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
This article describes the class ''I2CE_Encoding''. | This article describes the class ''I2CE_Encoding''. | ||
*Location: Part of the module [[TextLayout Tools Module List#textlayout|textlayout]] in the package [https://launchpad.net/textlayout TextLayout Tools] | *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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/textlayout/4.0.1-release/annotate/head:/lib/I2CE_Encoding.php lib/I2CE_Encoding.php] | ||
helper library to store/look-up glyphnames associated to a character code. | helper library to store/look-up glyphnames associated to a character code. | ||
==Variables== | ==Variables== |
Revision as of 15:14, 29 October 2009
This article describes the class I2CE_Encoding.
- Location: Part of the module textlayout in the package TextLayout Tools
- Source: Defined in the file lib/I2CE_Encoding.php
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
- Type: protected $glyph_names
$encoding
- Type: protected $encoding
$mb_encoding
protected @var string $unicode_encoding
- Type: protected $mb_encoding
$useMB
- Type: protected $useMB
$fix
Some common incorrect glyph names
- Type: static public fix $fix
Methods
UnicodeFromCharactercode()
get the multibyte character associated to a character code
- Signature: public function UnicodeFromCharactercode($cc)
- Parameters:
- int $cc
the character code
- int $cc
- Returns: int
unicode codepoint
UnicodeFromGlyphname()
get the multibyte character associated to a glyphname
- Signature: public function UnicodeFromGlyphname($gn)
- Parameters:
- string $gn
the glyp hname
- string $gn
- Returns: string
n character in the selected encoding
UnicodeToCharacterCode()
get the character code to a unicode codepoint
- Signature: public function UnicodeToCharacterCode($in)
- Parameters:
- mixed $in
UnicodeToGlyphname()
get the glpyh name associated to to a unicode codepoint
- Signature: public function UnicodeToGlyphname($in)
- Parameters:
- mixed $in
__construct()
@param string $encoding_type -- set to the encoding used needs to be one of PHP multibyte strings encodings
- 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
- Signature: public function changeGlyphNames($names)
- Parameters:
- $names
fixEuro()
Make sure U+20AC has the glyphname euro if it exists in this encoding
- Signature: public function fixEuro()
getEncodingType()
Get the unicode encoding to use
- Signature: public function getEncodingType()
- Returns: string
$encoding with values:
readMap()
Read in a character encoding from a file
- Signature: public function readMap($enc_file)
- Parameters:
- string $enc_file
the file containing the character encoded exmaples are cp1250.map ISO-8859-1.map etc. this function has been graciously stolen from makefont.php
- string $enc_file
setCharacterCode()
Set the character code assoicated to a unicode code point
- Signature: public function setCharacterCode($cp,$cc)
- Parameters:
setEncodingType()
- Signature: protected function setEncodingType($mb_encoding)
- Parameters:
- $mb_encoding
setGlyphname()
Set the gylph name of a character
- Signature: public function setGlyphname($cp,$gn)
- Parameters:
useMB()
- Signature: public function useMB()