eZ Publish  [trunk]
Public Member Functions | Static Public Member Functions
eZTextCodec Class Reference
Internationalization

Handles conversion from one charset to another. More...

+ Inheritance diagram for eZTextCodec:

List of all members.

Public Member Functions

 conversionRequired ()
 convertCodepage ($str)
 convertCodepageMapper ($str)
 convertCodepageRev ($str)
 convertCodepageToUnicode ($str)
 convertMBString ($str)
 convertNone ($str)
 convertNoneToUnicode ($str)
 convertString ($str)
 convertUnicodeToCodepage ($unicodeValues)
 convertUnicodeToUTF8 ($unicodeValues)
 convertUTF8ToUnicode ($str)
 eZTextCodec ($inputCharsetCode, $outputCharsetCode, $realInputCharsetCode, $realOutputCharsetCode, $inputEncoding, $outputEncoding)
 initializeCodepageMapper ()
 initializeConversionFunction ($encodingConvertInitMap, $encodingConvertInitFunction)
 initializeInputCodepage ()
 initializeOutputCodepage ()
 inputCharsetCode ()
 outputCharsetCode ()
 requestedInputCharsetCode ()
 requestedOutputCharsetCode ()
 setUseMBString ($use)
 strlen ($str)
 strlenCodepage ($str)
 strlenCodepageMapper ($str)
 strlenCodepageRev ($str)
 strlenMBString ($str)
 strlenNone ($str)
 strlenUnicode ($unicodeValues)
 strlenUTF8 ($str)
 useMBString ()

Static Public Member Functions

static httpCharset ()
static instance ($inputCharsetCode, $outputCharsetCode=false, $alwaysReturn=true)
 Returns a shared instance of the eZTextCodec pr the $inputCharsetCode and $outputCharsetCode params.
static internalCharset ()
static updateSettings ($settings)

Detailed Description

Handles conversion from one charset to another.

Supports utf8 encoding/decoding

Definition at line 22 of file eztextcodec.php.

Member Function Documentation

eZTextCodec::conversionRequired ( )

/

Returns:
true if a conversion is required, if false there's no need to call the textcodec functions.

Definition at line 253 of file eztextcodec.php.

eZTextCodec::convertCodepage ( $  str)

Definition at line 352 of file eztextcodec.php.

eZTextCodec::convertCodepageMapper ( $  str)

Definition at line 368 of file eztextcodec.php.

eZTextCodec::convertCodepageRev ( $  str)

Definition at line 360 of file eztextcodec.php.

eZTextCodec::convertCodepageToUnicode ( $  str)

Definition at line 315 of file eztextcodec.php.

eZTextCodec::convertMBString ( $  str)

Definition at line 376 of file eztextcodec.php.

eZTextCodec::convertNone ( $  str)

Definition at line 347 of file eztextcodec.php.

eZTextCodec::convertNoneToUnicode ( $  str)
Returns:
an empty array since no conversion is possible.

Definition at line 310 of file eztextcodec.php.

eZTextCodec::convertString ( $  str)

Definition at line 291 of file eztextcodec.php.

eZTextCodec::convertUnicodeToCodepage ( $  unicodeValues)

Definition at line 331 of file eztextcodec.php.

eZTextCodec::convertUnicodeToUTF8 ( $  unicodeValues)

Definition at line 339 of file eztextcodec.php.

eZTextCodec::convertUTF8ToUnicode ( $  str)

Definition at line 323 of file eztextcodec.php.

eZTextCodec::eZTextCodec ( $  inputCharsetCode,
$  outputCharsetCode,
$  realInputCharsetCode,
$  realOutputCharsetCode,
$  inputEncoding,
$  outputEncoding 
)

Definition at line 24 of file eztextcodec.php.

Referenced by eZCodePageCodec\eZCodePageCodec(), and instance().

static eZTextCodec::httpCharset ( ) [static]
Returns:
a charset value which can be used in HTTP headers.
Note:
Will return the internalCharset() if not http charset is set.

Definition at line 558 of file eztextcodec.php.

eZTextCodec::initializeCodepageMapper ( )

Definition at line 234 of file eztextcodec.php.

eZTextCodec::initializeConversionFunction ( $  encodingConvertInitMap,
$  encodingConvertInitFunction 
)

Definition at line 212 of file eztextcodec.php.

Referenced by eZTextCodec().

eZTextCodec::initializeInputCodepage ( )

Definition at line 240 of file eztextcodec.php.

eZTextCodec::initializeOutputCodepage ( )

Definition at line 245 of file eztextcodec.php.

eZTextCodec::inputCharsetCode ( )

Definition at line 281 of file eztextcodec.php.

static eZTextCodec::instance ( $  inputCharsetCode,
$  outputCharsetCode = false,
$  alwaysReturn = true 
) [static]

Returns a shared instance of the eZTextCodec pr the $inputCharsetCode and $outputCharsetCode params.

Parameters:
string | false$inputCharsetCodeUses eZTextCodec::internalCharset() if false
string | false$outputCharsetCodeUses eZTextCodec::internalCharset() if false
bool$alwaysReturn
Returns:
eZTextCodec|null Returns null if $alwaysReturn is false and text codec is not needed for current $inputCharsetCode and $outputCharsetCode.

Definition at line 436 of file eztextcodec.php.

Referenced by eZXMLInputParser\convertNumericEntities(), eZMail\convertText(), eZMail\encodeMimeHeader(), eZCodeMapper\executeCommandCode(), eZDBInterface\eZDBInterface(), eZAlphabetOperator\fetchAlphabet(), eZCodePageCodec\fromUnicode(), eZCodeMapper\generateCharsetMappingTable(), eZTSTranslator\handleMessageNode(), eZTemplateFileResource\handleResourceData(), initializeCodepageMapper(), initializeInputCodepage(), initializeOutputCodepage(), internalCharset(), eZPDF\modify(), eZTemplateStringOperator\modify(), eZCodeMapper\parseTransformationFile(), eZXMLTextType\rawXMLText(), eZWebDAVServer\recode(), eZWebDAVContentBackend\recode(), strlenUTF8(), and eZStringType\validateStringHTTPInput().

static eZTextCodec::internalCharset ( ) [static]
Returns:
the charset which is used internally, this is the charset which all external files and resources are converted to.
Note:
will return iso-8859-1 if eZTextCodec has been updated with proper settings.

Definition at line 536 of file eztextcodec.php.

Referenced by eZDFSFileHandlerMySQLBackend\_connect(), eZDBFileHandlerMysqlBackend\_connect(), eZDBFileHandlerMysqliBackend\_connect(), eZDFSFileHandlerMySQLiBackend\_connect(), eZINI\cacheFileName(), eZTemplateCompiler\compilationFilename(), eZObjectRelationListType\domString(), eZMatrix\domString(), eZCodeMapper\executeCommandCode(), httpCharset(), eZDB\instance(), instance(), eZTSTranslator\loadTranslationFile(), eZPDF\modify(), eZTemplateStringOperator\modify(), eZTranslationCache\rootCacheDirectory(), eZTranslationCache\storeCache(), eZURLAliasML\strtolower(), eZCharTransform\transform(), eZCharTransform\transformByGroup(), and eZTemplateTreeCache\treeCacheFilename().

eZTextCodec::outputCharsetCode ( )

Definition at line 286 of file eztextcodec.php.

eZTextCodec::requestedInputCharsetCode ( )

Definition at line 271 of file eztextcodec.php.

eZTextCodec::requestedOutputCharsetCode ( )

Definition at line 276 of file eztextcodec.php.

eZTextCodec::setUseMBString ( $  use)

Definition at line 258 of file eztextcodec.php.

eZTextCodec::strlen ( $  str)

Definition at line 301 of file eztextcodec.php.

Referenced by eZCodePageCodec\fromUnicode(), strlenNone(), and eZCodePageCodec\toUnicode().

eZTextCodec::strlenCodepage ( $  str)

Definition at line 397 of file eztextcodec.php.

eZTextCodec::strlenCodepageMapper ( $  str)

Definition at line 413 of file eztextcodec.php.

eZTextCodec::strlenCodepageRev ( $  str)

Definition at line 408 of file eztextcodec.php.

eZTextCodec::strlenMBString ( $  str)

Definition at line 418 of file eztextcodec.php.

eZTextCodec::strlenNone ( $  str)

Definition at line 387 of file eztextcodec.php.

eZTextCodec::strlenUnicode ( $  unicodeValues)

Definition at line 392 of file eztextcodec.php.

eZTextCodec::strlenUTF8 ( $  str)

Definition at line 402 of file eztextcodec.php.

static eZTextCodec::updateSettings ( $  settings) [static]

Initializes the eZTextCodec settings to the ones in the array $settings.

See also:
internalCharset, httpCharset.

Definition at line 516 of file eztextcodec.php.

Referenced by eZUpdateTextCodecSettings(), and eZScript\updateTextCodecSettings().

eZTextCodec::useMBString ( )

Definition at line 263 of file eztextcodec.php.

Referenced by eZTextCodec().

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