eZCodePage Class Reference
[Internationalization]

Handles codepage files for charset mapping. More...

List of all members.


Public Methods

 eZCodePage ($charset_code,$use_cache=true)
 load ($use_cache=true)
 charsetCode ()
 requestedCharsetCode ()
 minCharValue ()
 maxCharValue ()
 isValid ()
instance ($charset_code,$use_cache=true)

Static Public Methods

 exists ($charset_code)
 fileName ($charset_code)

Private Attributes

 RequestedCharsetCode
 CharsetCode
 The read charset code, may differ from $RequestedCharsetCode.

 CharsetEncodingScheme
 Encoding scheme for current charset, for instance utf-8, singlebyte, multibyte.

 UnicodeMap
 Maps normal codes to unicode.

 UTF8Map
 Maps normal codes to utf8.

 CodeMap
 Maps unicode to normal codes.

 UTF8CodeMap
 Maps utf8 to normal codes.

 MinCharValue
 The minimum key value for the mapping tables.

 MaxCharValue
 The maximum key value for the mapping tables.

 Valid
 Whether the codepage is valid or not.

 SubstituteChar
 The character to use when an alternative doesn't exist.


Detailed Description

Handles codepage files for charset mapping.

Definition at line ezcodepage.php.


Constructor & Destructor Documentation

eZCodePage::eZCodePage   charset_code,
  use_cache = true
 

Initializes the codepage with the charset code $charset_code, and then loads it.

Definition at line ezcodepage.php.

References Valid.

Referenced by instance().


Member Function Documentation

eZCodePage::charsetCode  
 

Returns:
the charset code which is in use. This may not be the charset that was requested due to aliases.
See also:
requestedCharsetCode

Definition at line ezcodepage.php.

References CharsetCode.

eZCodePage::exists   charset_code [static]
 

Returns true if the codepage $charset_code exists.

Definition at line ezcodepage.php.

References fileName().

eZCodePage::fileName   charset_code [static]
 

Returns the filename of the charset code $charset_code.

Definition at line ezcodepage.php.

References eZCharsetInfo::realCharsetCode().

Referenced by exists().

& eZCodePage::instance   charset_code,
  use_cache = true
 

Returns the only instance of the codepage for $charset_code.

Definition at line ezcodepage.php.

References eZCodePage().

eZCodePage::isValid  
 

Returns true if the codepage is valid for use.

Definition at line ezcodepage.php.

References Valid.

eZCodePage::load   use_cache = true
 

Loads the codepage from disk. If $use_cache is true and a cached version is found it is used instead. If $use_cache is true and no cache was found a new cache is created.

Definition at line ezcodepage.php.

References eZDebug::writeWarning().

Referenced by eZCodePage().

eZCodePage::maxCharValue  
 

Returns:
the largest character value used in the mapping table.

Definition at line ezcodepage.php.

References MaxCharValue.

eZCodePage::minCharValue  
 

Returns:
the lowest character value used in the mapping table.

Definition at line ezcodepage.php.

References MinCharValue.

eZCodePage::requestedCharsetCode  
 

Returns:
the charset code which was requested, may differ from charsetCode()

Definition at line ezcodepage.php.

References RequestedCharsetCode.


Member Data Documentation

eZCodePage::RequestedCharsetCode [private]
 

The charset code which was requested, may differ from $CharsetCode

Definition at line ezcodepage.php.

Referenced by requestedCharsetCode().


The documentation for this class was generated from the following file:  

Exponential