Class: I2CE Encoding

From IHRIS Wiki
Revision as of 21:14, 16 October 2009 by Litlfred (talk | contribs)

This article desrcibes the class I2CE_Encoding It is contained in the module textlayout in the package TextLayout Tools

The class is 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)
  • Returns: int unicode codepoint

Parameters:

  • int $cc
    the character code

UnicodeFromGlyphname()

get the multibyte character associated to a glyphname

  • Signature: public function UnicodeFromGlyphname($gn)
  • Returns: string n character in the selected encoding

Parameters:

UnicodeToCharacterCode()

get the character code to a unicode codepoint

  • Signature: public function UnicodeToCharacterCode($in)

Parameters:

UnicodeToGlyphname()

get the glpyh name associated to to a unicode codepoint

  • Signature: public function UnicodeToGlyphname($in)

Parameters:

__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 exmaples are cp1250.map ISO-8859-1.map etc. this function has been graciously stolen from makefont.php

  • Signature: public function readMap($enc_file)

Parameters:

  • string $enc_file
    the file containing the character encoded

setCharacterCode()

Set the character code assoicated to a unicode code point

  • Signature: public function setCharacterCode($cp,$cc)

Parameters:

  • int $cp
    the unicode code point
  • mixed $cc
    the character code (either int or a character)

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:

  • int $cp
    the unicode code point
  • string $gn
    the glyphname

useMB()

  • Signature: public function useMB()