eZTextCodec Class Reference

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 40 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 271 of file eztextcodec.php.

eZTextCodec::convertCodepage

(

$

str

)

Definition at line 370 of file eztextcodec.php.

eZTextCodec::convertCodepageMapper

(

$

str

)

Definition at line 386 of file eztextcodec.php.

eZTextCodec::convertCodepageRev

(

$

str

)

Definition at line 378 of file eztextcodec.php.

eZTextCodec::convertCodepageToUnicode

(

$

str

)

Definition at line 333 of file eztextcodec.php.

eZTextCodec::convertMBString

(

$

str

)

Definition at line 394 of file eztextcodec.php.

eZTextCodec::convertNone

(

$

str

)

Definition at line 365 of file eztextcodec.php.

eZTextCodec::convertNoneToUnicode

(

$

str

)

Returns:

an empty array since no conversion is possible.

Definition at line 328 of file eztextcodec.php.

eZTextCodec::convertString

(

$

str

)

Definition at line 309 of file eztextcodec.php.

eZTextCodec::convertUnicodeToCodepage

(

$

unicodeValues

)

Definition at line 349 of file eztextcodec.php.

eZTextCodec::convertUnicodeToUTF8

(

$

unicodeValues

)

Definition at line 357 of file eztextcodec.php.

eZTextCodec::convertUTF8ToUnicode

(

$

str

)

Definition at line 341 of file eztextcodec.php.

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

Definition at line 42 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 576 of file eztextcodec.php.

eZTextCodec::initializeCodepageMapper

(

)

Definition at line 252 of file eztextcodec.php.

eZTextCodec::initializeConversionFunction	(	$	encodingConvertInitMap,
		$	encodingConvertInitFunction
	)

Definition at line 230 of file eztextcodec.php.

Referenced by eZTextCodec().

eZTextCodec::initializeInputCodepage

(

)

Definition at line 258 of file eztextcodec.php.

eZTextCodec::initializeOutputCodepage

(

)

Definition at line 263 of file eztextcodec.php.

eZTextCodec::inputCharsetCode

(

)

Definition at line 299 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:

$inputCharsetCode	string|false uses eZTextCodec::internalCharset() if false
$outputCharsetCode	string|false uses eZTextCodec::internalCharset() if false
$alwaysReturn	bool

Returns:

eZTextCodec|null Returns null if $alwaysReturn is false and text codec is not needed for current $inputCharsetCode and $outputCharsetCode.

Definition at line 454 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 554 of file eztextcodec.php.

Referenced by eZINI\cacheFileName(), eZTemplateCompiler\compilationFilename(), eZObjectRelationListType\domString(), eZMatrix\domString(), eZCodeMapper\executeCommandCode(), eZMail\eZMail(), 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 304 of file eztextcodec.php.

eZTextCodec::requestedInputCharsetCode

(

)

Definition at line 289 of file eztextcodec.php.

eZTextCodec::requestedOutputCharsetCode

(

)

Definition at line 294 of file eztextcodec.php.

eZTextCodec::setUseMBString

(

$

use

)

Definition at line 276 of file eztextcodec.php.

eZTextCodec::strlen

(

$

str

)

Definition at line 319 of file eztextcodec.php.

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

eZTextCodec::strlenCodepage

(

$

str

)

Definition at line 415 of file eztextcodec.php.

eZTextCodec::strlenCodepageMapper

(

$

str

)

Definition at line 431 of file eztextcodec.php.

eZTextCodec::strlenCodepageRev

(

$

str

)

Definition at line 426 of file eztextcodec.php.

eZTextCodec::strlenMBString

(

$

str

)

Definition at line 436 of file eztextcodec.php.

eZTextCodec::strlenNone

(

$

str

)

Definition at line 405 of file eztextcodec.php.

eZTextCodec::strlenUnicode

(

$

unicodeValues

)

Definition at line 410 of file eztextcodec.php.

eZTextCodec::strlenUTF8

(

$

str

)

Definition at line 420 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 534 of file eztextcodec.php.

Referenced by eZScript\updateTextCodecSettings().

eZTextCodec::useMBString

(

)

Definition at line 281 of file eztextcodec.php.

Referenced by eZTextCodec().

---

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

• eztextcodec.php