
	Manual


	SDK

eZXMLTextType Class Reference

The class eZXMLTextType haneles XML formatted datatypes. More...

Inheritance diagram for eZXMLTextType:

List of all members.


Public Methods
	initializeClassAttribute (&$classAttribute)
	initializeObjectAttribute (&$contentObjectAttribute,$currentVersion,&$originalContentObjectAttribute)
	validateObjectAttributeHTTPInput (&$http,$base,&$contentObjectAttribute)
	fetchClassAttributeHTTPInput (&$http,$base,&$classAttribute)
	fetchObjectAttributeHTTPInput (&$http,$base,&$contentObjectAttribute)
	storeObjectAttribute (&$attribute)
&	viewTemplate (&$contentobjectAttribute)
&	editTemplate (&$contentobjectAttribute)
&	informationTemplate (&$contentobjectAttribute)
&	viewTemplateSuffix (&$contentobjectAttribute)
&	editTemplateSuffix (&$contentobjectAttribute)
&	informationTemplateSuffix (&$contentobjectAttribute)
	rawXMLText (&$contentObjectAttribute)
&	objectAttributeContent (&$contentObjectAttribute)
	metaData ($contentObjectAttribute)
	title (&$contentObjectAttribute)
	isIndexable ()
	isInformationCollector ()
&	serializeContentObjectAttribute ($objectAttribute)
Static Public Methods
	domString (&$domDocument)

Detailed Description

The class eZXMLTextType haneles XML formatted datatypes.

The formatted datatypes store the data in XML. A typical example of this is shown below:

<?xml version="1.0" encoding="utf-8" ?>
<section>
<header>This is a level one header</header>
<paragraph>
This is a <emphasize>block</emphasize> of text.
</paragraph>
  <section>
  <header>This is a level two header</header>
  <paragraph>
  This is the second paragraph.<emphasize>emphasized/bold text</emphasize>
  </paragraph>
  <header>This is a level two header</header>
  <paragraph>
  This is the second paragraph.<emphasize>emphasized/bold text</emphasize>
  </paragraph>
  <paragraph>
  This is the second paragraph.<emphasize>emphasized/bold text</emphasize>
  </paragraph>
  <paragraph>
  <ul>
     <li>List item 1</li>
     <li>List item 2</li>
  </ul>
  </paragraph>
  <header>This is a level two header</header>
  </section>
</section>

Definition at line ezxmltexttype.php.

Member Function Documentation

eZXMLTextType::domString ( &$ domDocument ) [static]

Returns:: the XML structure in $domDocument as text. It will take of care of the necessary charset conversions for content storage.

Definition at line ezxmltexttype.php.

References eZCharsetInfo::realCharsetCode().

Referenced by domString().

& eZXMLTextType::editTemplate

(

&$

contentobjectAttribute

)

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

References editTemplateSuffix().

& eZXMLTextType::editTemplateSuffix

(

&$

contentobjectAttribute

)

Reimplemented for internal reasons; the API is not affected.

Definition at line ezxmltexttype.php.

References objectAttributeContent().

Referenced by editTemplate().

eZXMLTextType::fetchClassAttributeHTTPInput	(	&$	http,
		$	base,
		&$	classAttribute
	)

Fetches the HTTP input for the content class attribute.

Note:: Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

eZXMLTextType::fetchObjectAttributeHTTPInput	(	&$	http,
		$	base,
		&$	contentObjectAttribute
	)

Fetches the http post var string input and stores it in the data instance.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

& eZXMLTextType::informationTemplate

(

&$

contentobjectAttribute

)

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

References informationTemplateSuffix().

& eZXMLTextType::informationTemplateSuffix

(

&$

contentobjectAttribute

)

Reimplemented for internal reasons; the API is not affected.

Definition at line ezxmltexttype.php.

References objectAttributeContent().

Referenced by informationTemplate().

eZXMLTextType::initializeClassAttribute

(

&$

classAttribute

)

Set class attribute value for template version

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

eZXMLTextType::initializeObjectAttribute	(	&$	contentObjectAttribute,
		$	currentVersion,
		&$	originalContentObjectAttribute
	)

Sets the default value.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

References rawXMLText().

eZXMLTextType::isIndexable

(

)

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

eZXMLTextType::isInformationCollector

(

)

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

eZXMLTextType::metaData

(

$

contentObjectAttribute

)

Returns the meta data used for storing search indeces.

Definition at line ezxmltexttype.php.

References rawXMLText().

Referenced by metaData().

& eZXMLTextType::objectAttributeContent

(

&$

contentObjectAttribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

References rawXMLText().

Referenced by viewTemplateSuffix().

eZXMLTextType::rawXMLText

(

&$

contentObjectAttribute

)

Returns:: the RAW XML text from the attribute $contentobjectAttribute. If the XML format is older than the current one it will be upgraded to the current before being returned.

Definition at line ezxmltexttype.php.

Referenced by title().

& eZXMLTextType::serializeContentObjectAttribute

(

$

objectAttribute

)

Returns:: a DOM representation of the content object attribute

Definition at line ezxmltexttype.php.

References rawXMLText().

eZXMLTextType::storeObjectAttribute

(

&$

attribute

)

Store the content.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

References eZDataType::attribute().

eZXMLTextType::title

(

&$

contentObjectAttribute

)

Returns the text.

Definition at line ezxmltexttype.php.

References rawXMLText().

eZXMLTextType::validateObjectAttributeHTTPInput	(	&$	http,
		$	base,
		&$	contentObjectAttribute
	)

Validates the input and returns true if the input was valid for this datatype.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

References objectAttributeContent().

& eZXMLTextType::viewTemplate

(

&$

contentobjectAttribute

)

Reimplemented for internal reasons; the API is not affected.

Reimplemented from eZDataType.

Definition at line ezxmltexttype.php.

References viewTemplateSuffix().

& eZXMLTextType::viewTemplateSuffix

(

&$

contentobjectAttribute

)

Reimplemented for internal reasons; the API is not affected.

Definition at line ezxmltexttype.php.

References objectAttributeContent().

Referenced by viewTemplate().

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

ezxmltexttype.php

Exponential