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
	httpCharset ()
&	instance ($inputCharsetCode, $outputCharsetCode=false, $alwaysReturn=true)
	internalCharset ()
	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 278 of file eztextcodec.php.

eZTextCodec::convertCodepage

(

$

str

)

Definition at line 378 of file eztextcodec.php.

eZTextCodec::convertCodepageMapper

(

$

str

)

Definition at line 394 of file eztextcodec.php.

eZTextCodec::convertCodepageRev

(

$

str

)

Definition at line 386 of file eztextcodec.php.

eZTextCodec::convertCodepageToUnicode

(

$

str

)

Definition at line 339 of file eztextcodec.php.

eZTextCodec::convertMBString

(

$

str

)

Definition at line 402 of file eztextcodec.php.

eZTextCodec::convertNone

(

$

str

)

Definition at line 373 of file eztextcodec.php.

eZTextCodec::convertNoneToUnicode

(

$

str

)

Returns:

an empty array since no conversion is possible.

Definition at line 334 of file eztextcodec.php.

eZTextCodec::convertString

(

$

str

)

Definition at line 316 of file eztextcodec.php.

eZTextCodec::convertUnicodeToCodepage

(

$

unicodeValues

)

Definition at line 356 of file eztextcodec.php.

eZTextCodec::convertUnicodeToUTF8

(

$

unicodeValues

)

Definition at line 364 of file eztextcodec.php.

eZTextCodec::convertUTF8ToUnicode

(

$

str

)

Definition at line 347 of file eztextcodec.php.

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

Definition at line 44 of file eztextcodec.php.

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

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

eZTextCodec::initializeCodepageMapper

(

)

Definition at line 256 of file eztextcodec.php.

eZTextCodec::initializeConversionFunction	(	$	encodingConvertInitMap,
		$	encodingConvertInitFunction
	)

Definition at line 234 of file eztextcodec.php.

Referenced by eZTextCodec().

eZTextCodec::initializeInputCodepage

(

)

Definition at line 263 of file eztextcodec.php.

eZTextCodec::initializeOutputCodepage

(

)

Definition at line 269 of file eztextcodec.php.

eZTextCodec::inputCharsetCode

(

)

Definition at line 306 of file eztextcodec.php.

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

Returns:

a text codec instance which can be used to convert from input charset $inputCharsetCode and into output charset $outputCharsetCode.

Parameters:

	$inputCharsetCode	If false the internal charset it used, otherwise it is used directly
	$outputCharsetCode	If false the internal charset it used, otherwise it is used directly
	$alwaysReturn	If false it will only return a textcodec instance if it is required for the input and output charset. In which case it returns null.

Definition at line 461 of file eztextcodec.php.

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

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

Referenced by eZTemplateCompiler::compilationFilename(), eZXMLTextType::domString(), eZObjectRelationListType::domString(), eZMatrix::domString(), eZCodeMapper::executeCommandCode(), eZMail::eZMail(), httpCharset(), instance(), eZDB::instance(), eZINI::loadCache(), eZTSTranslator::loadTranslationFile(), eZPDF::modify(), eZTranslationCache::rootCacheDirectory(), eZTranslationCache::storeCache(), eZCharTransform::transform(), eZCharTransform::transformByGroup(), and eZTemplateTreeCache::treeCacheFilename().

eZTextCodec::outputCharsetCode

(

)

Definition at line 311 of file eztextcodec.php.

eZTextCodec::requestedInputCharsetCode

(

)

Definition at line 296 of file eztextcodec.php.

eZTextCodec::requestedOutputCharsetCode

(

)

Definition at line 301 of file eztextcodec.php.

eZTextCodec::setUseMBString

(

$

use

)

Definition at line 283 of file eztextcodec.php.

eZTextCodec::strlen

(

$

str

)

Definition at line 325 of file eztextcodec.php.

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

eZTextCodec::strlenCodepage

(

$

str

)

Definition at line 423 of file eztextcodec.php.

eZTextCodec::strlenCodepageMapper

(

$

str

)

Definition at line 439 of file eztextcodec.php.

eZTextCodec::strlenCodepageRev

(

$

str

)

Definition at line 434 of file eztextcodec.php.

eZTextCodec::strlenMBString

(

$

str

)

Definition at line 444 of file eztextcodec.php.

eZTextCodec::strlenNone

(

$

str

)

Definition at line 413 of file eztextcodec.php.

eZTextCodec::strlenUnicode

(

$

unicodeValues

)

Definition at line 418 of file eztextcodec.php.

eZTextCodec::strlenUTF8

(

$

str

)

Definition at line 428 of file eztextcodec.php.

eZTextCodec::updateSettings

(

$

settings

)

[static]

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

See also:

internalCharset, httpCharset.

Definition at line 540 of file eztextcodec.php.

Referenced by eZScript::updateTextCodecSettings().

eZTextCodec::useMBString

(

)

Definition at line 288 of file eztextcodec.php.

Referenced by eZTextCodec().

---

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

• eztextcodec.php