[ Index ]

PHP Cross Reference of Akelos Framework

title

Body

[close]

/ -> AkCharset.php (summary)

(no description)

Author: Bermi Ferrer
Copyright: Copyright (c) 2002-2006, Akelos Media, S.L. http://www.akelos.org
License: GNU Lesser General Public License
File Size: 745 lines (28 kb)
Included or required: 3 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

AkCharset:: (21 methods):
  GetRecodingEngine()
  GetRecodingEngineExtraParams()
  GetCurrentCharset()
  SetRecodingEngine()
  iconv()
  SetRecodingEngineExtraParams()
  RecodeString()
  GetMapping()
  _LoadExtension()
  _IconvStringRecode()
  _RecodeStringRecode()
  _MbstringStringRecode()
  _PhpStringRecode()
  _ConversionIsNeeded()
  _GetCharset()
  _Utf8StringEncode()
  _Utf8StringDecode()
  _CharToUtf8()
  _Utf8ToChar()
  isUtf8()
  _charsetMapFileExists()


Class: AkCharset  - X-Ref

Charset conversion using UT8 mapping tables.

Charset conversion using 4 different methods. Pure PHP
conversion or one of this PHP extensions  iconv, recode and
multibyte.

Supported charsets are:
ASCII, ISO 8859-1, ISO 8859-2, ISO 8859-3, ISO 8859-4, ISO
8859-5, ISO 8859-6, ISO 8859-7, ISO 8859-8, ISO 8859-9, ISO
8859-10, ISO 8859-11, ISO 8859-13, ISO 8859-14, ISO 8859-15,
ISO 8859-16, CP437, CP737, CP850, CP852, CP855, CP857,
CP858, CP860, CP861, CP863, CP865, CP866, CP869,
Windows-1250, Windows-1251, Windows-1252, Windows-1253,
Windows-1254, Windows-1255, Windows-1256, Windows-1257,
Windows-1258, KOI8-R, KOI8-U, ISCII, VISCII, Big5, HKSCS,
GB2312, GB18030, Shift-JIS, EUC

More information about charsets at
http://en.wikipedia.org/wiki/Character_encoding

GetRecodingEngine()   X-Ref
$this->_recodingEngine getter

Use this method to get $this->_recodingEngine value

return: string    Returns Current encoding engine value.

GetRecodingEngineExtraParams()   X-Ref
$this->_recodingEngineExtraParams getter

Use this method to get $this->_recodingEngineExtraParams
value

return: string    Returns Extra parameters for invoking the encoding

GetCurrentCharset()   X-Ref
$this->_currentCharset getter

Use this method to get $this->_currentCharset value

return: string    Returns Holds current procesing charset. value.

SetRecodingEngine($engine = null, $extra_params = null)   X-Ref
Sets the default recoding engine.

param: string    $engine    Possible engines are:
param: string    $extra_params    Extra parameters for invoking the encoding engine
return: string    Name of current recoding engine

iconv($input_encoding, $output_encoding, $string)   X-Ref
No description

SetRecodingEngineExtraParams($recoding__engine__extra__params)   X-Ref
$this->_recodingEngineExtraParams setter

Use this method to set $this->_recodingEngineExtraParams
value

param: string    $recoding__engine__extra__params    Extra parameters for invoking the encoding engine
return: bool    Returns true if $this->_recodingEngineExtraParams

RecodeString($string, $target_charset, $origin_charset = null, $engine = null, $engine_extra_params = null)   X-Ref
Changes the charset encoding of one string to other charset.

This function will convert a string from one charset to
another.
Unfortunately PHP has not native Unicode support, so in
order to display and handle different charsets, this
function wraps 3 non standard PHP extensions plus an
additional Pure PHP conversion utility for systems that do
not have this extensions enabled.

param: string    $string    String to recode
param: string    $target_charset    Target charset. AkCharset availability may vary
param: string    $origin_charset    Input string charset. AkCharset availability may
param: string    $engine    Possible engines are:
param: string    $engine_extra_params    Extra parameters for invoking the encoding engine
return: void    Recoded string if possible, otherwise it will

GetMapping($charset)   X-Ref
Fetch an array with UTF8 charset equivalence table.

param: string    $charset    Desired charset
return: mixed    Multilevel array with selected mapping:

_LoadExtension($extension)   X-Ref
Tries to load required extension.

param: string    $extension    Extension name
return: boolean    Returns true on success false on failure.

_IconvStringRecode($string, $target_charset, $origin_charset, $engine_extra_params=null)   X-Ref
AkCharset::RecodeString() iconv implementation

return: string    Recoded string if possible, otherwise it will

_RecodeStringRecode($string, $target_charset, $origin_charset)   X-Ref
AkCharset::RecodeString() recode_string implementation

return: string    Recoded string if possible, otherwise it will

_MbstringStringRecode($string, $target_charset, $origin_charset=null)   X-Ref
AkCharset::RecodeString() mb_convert_encoding implementation

return: string    Recoded string if possible, otherwise it will

_PhpStringRecode($string, $target_charset, $origin_charset)   X-Ref
AkCharset::RecodeString() Pure PHP implementation

return: string    Recoded string if possible, otherwise it will

_ConversionIsNeeded($origin_charset, $target_charset)   X-Ref
Checks for possibility or need of charset conversion.

param: string    $origin_charset
param: string    $target_charset
return: boolean

_GetCharset($charset = null, $set_charset = true)   X-Ref
Filters input charset and returns a custom formated value
for class wide usage.

param: string    $charset    AkCharset name
param: boolean    $set_charset    If true will set $this->defaultCharset value
return: mixed    AkCharset internal name or FALSE if charset is not

_Utf8StringEncode($string, $mapping_array)   X-Ref
Encodes given string as UTF8 text.

Given string and charset mapping, returns input string as
UTF8 text

param: string    $string    Text to be converted to UTF8
param: array    $mapping_array    Array containing the charset mapping.
return: string    UTF8 String

_Utf8StringDecode($utf_string, $mapping_array)   X-Ref
Decodes data, assumed to be UTF-8 encoded given its
equivalence map.

param: string    $utf_string    UTF8 string
param: array    $mapping_array    Mapping array
return: string    Decoded string

_CharToUtf8($char)   X-Ref
Converts a single character to its UTF8 representation

param: string    $char    Char to be converted
return: string    UTF8 char

_Utf8ToChar($chars, &$id, $mapping_array)   X-Ref
Decodes a single UTF8 char to it's representation as
specified in the mapping array

param: array    $chars    Assoc array with chars to be decoded
param: integer    &$id    Current char position
param: array    $mapping_array    Mapping Array
return: string    Decoded char

isUtf8($text = '')   X-Ref
No description

_charsetMapFileExists($charset)   X-Ref
No description



Generated: Mon Oct 27 12:43:49 2008 Cross-referenced by PHPXref 0.6