eZXMLInputHandler Class Reference

The class eZXMLInputHandler does. More...

Inheritance diagram for eZXMLInputHandler:

List of all members.

Public Member Functions
	attribute ($name)
	attributes ()
	convertInput ($text)
	customObjectAttributeHTTPAction ($http, $action, $contentObjectAttribute)
	editTemplateName ()
	editTemplateSuffix (&$contentobjectAttribute)
	eZXMLInputHandler ($xmlData, $aliasedType, $contentObjectAttribute)
	hasAttribute ($name)
	informationTemplateName ()
	informationTemplateSuffix (&$contentobjectAttribute)
	inputXML ()
	isValid ()
	validateInput ($http, $base, $contentObjectAttribute)
	xmlData ()
Public Attributes
	$AliasedHandler
	$AliasedType
	$ContentObjectAttribute
	$XMLData
	Contains the XML data as text.

---

Detailed Description

The class eZXMLInputHandler does.

Definition at line 41 of file ezxmlinputhandler.php.

---

Member Function Documentation

eZXMLInputHandler::attribute

(

$

name

)

Returns:

the value of the attribute $name if it exists, if not returns null.

Definition at line 78 of file ezxmlinputhandler.php.

eZXMLInputHandler::attributes

(

)

Returns:

an array with attribute names.

Definition at line 58 of file ezxmlinputhandler.php.

Referenced by hasAttribute().

eZXMLInputHandler::convertInput

(

$

text

)

[pure virtual]

Converts text input $text into an XML structure and returns it.

Returns:

an array where index 0 is the xml structure and index 1 is a message.

Definition at line 205 of file ezxmlinputhandler.php.

eZXMLInputHandler::customObjectAttributeHTTPAction	(	$	http,
		$	action,
		$	contentObjectAttribute
	)		[pure virtual]

Handles custom actions for input handler.

Note:

Default does nothing, reimplement to check actions.

Definition at line 151 of file ezxmlinputhandler.php.

eZXMLInputHandler::editTemplateName

(

)

Returns:

the template name for this input handler, includes the edit suffix if any.

Definition at line 121 of file ezxmlinputhandler.php.

Referenced by attribute().

eZXMLInputHandler::editTemplateSuffix

(

&$

contentobjectAttribute

)

[pure virtual]

Returns:

the suffix for the attribute template, if false it is ignored.

Definition at line 169 of file ezxmlinputhandler.php.

Referenced by editTemplateName().

eZXMLInputHandler::eZXMLInputHandler	(	$	xmlData,
		$	aliasedType,
		$	contentObjectAttribute
	)

Constructor

Definition at line 46 of file ezxmlinputhandler.php.

Referenced by eZSimplifiedXMLInput\eZSimplifiedXMLInput().

eZXMLInputHandler::hasAttribute

(

$

name

)

Returns:

true if the attribute $name exists.

Definition at line 70 of file ezxmlinputhandler.php.

eZXMLInputHandler::informationTemplateName

(

)

Returns:

the template name for this input handler, includes the information suffix if any.

Definition at line 135 of file ezxmlinputhandler.php.

Referenced by attribute().

eZXMLInputHandler::informationTemplateSuffix

(

&$

contentobjectAttribute

)

[pure virtual]

Returns:

the suffix for the attribute template, if false it is ignored.

Definition at line 178 of file ezxmlinputhandler.php.

Referenced by informationTemplateName().

eZXMLInputHandler::inputXML

(

)

[pure virtual]

Returns the text representation of the XML structure, implement this to turn XML back into user input.

Implemented in eZSimplifiedXMLInput.

Definition at line 215 of file ezxmlinputhandler.php.

Referenced by attribute().

eZXMLInputHandler::isValid

(

)

Returns:

true if the input handler is considered valid, if not the handler will not be used.

Note:

Default returns true

Definition at line 160 of file ezxmlinputhandler.php.

eZXMLInputHandler::validateInput	(	$	http,
		$	base,
		$	contentObjectAttribute
	)		[pure virtual]

Validates user input and returns whether it can be used or not.

Implemented in eZSimplifiedXMLInput.

Definition at line 195 of file ezxmlinputhandler.php.

eZXMLInputHandler::xmlData

(

)

Returns:

the xml data as text.

Definition at line 186 of file ezxmlinputhandler.php.

---

Member Data Documentation

eZXMLInputHandler::$AliasedHandler

Definition at line 224 of file ezxmlinputhandler.php.

eZXMLInputHandler::$AliasedType

Definition at line 223 of file ezxmlinputhandler.php.

eZXMLInputHandler::$ContentObjectAttribute

Definition at line 225 of file ezxmlinputhandler.php.

eZXMLInputHandler::$XMLData

Contains the XML data as text.

Definition at line 222 of file ezxmlinputhandler.php.

---

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

• ezxmlinputhandler.php