eZPublish  3.8
eZXMLInputHandler Class Referenceabstract

The class eZXMLInputHandler does. More...

+ Inheritance diagram for eZXMLInputHandler:

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 ()
 

Private Attributes

 $AliasedHandler
 
 $AliasedType
 
 $ContentObjectAttribute
 
 $XMLData
 Contains the XML data as text. More...
 

Detailed Description

The class eZXMLInputHandler does.

Member Function Documentation

& eZXMLInputHandler::attribute (   $name)
Returns
the value of the attribute $name if it exists, if not returns null.
eZXMLInputHandler::attributes ( )
Returns
an array with attribute names.

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.
eZXMLInputHandler::customObjectAttributeHTTPAction (   $http,
  $action,
$contentObjectAttribute 
)
pure virtual

Handles custom actions for input handler.

Note
Default does nothing, reimplement to check actions.
& eZXMLInputHandler::editTemplateName ( )
Returns
the template name for this input handler, includes the edit suffix if any.

Referenced by attribute().

& eZXMLInputHandler::editTemplateSuffix ( $contentobjectAttribute)
pure virtual
Returns
the suffix for the attribute template, if false it is ignored.

Referenced by editTemplateName().

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

Constructor

Referenced by eZSimplifiedXMLInput\eZSimplifiedXMLInput().

eZXMLInputHandler::hasAttribute (   $name)
Returns
true if the attribute $name exists.
& eZXMLInputHandler::informationTemplateName ( )
Returns
the template name for this input handler, includes the information suffix if any.

Referenced by attribute().

& eZXMLInputHandler::informationTemplateSuffix ( $contentobjectAttribute)
pure virtual
Returns
the suffix for the attribute template, if false it is ignored.

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.

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
& eZXMLInputHandler::validateInput ( $http,
  $base,
$contentObjectAttribute 
)
pure virtual

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

Implemented in eZSimplifiedXMLInput.

eZXMLInputHandler::xmlData ( )
Returns
the xml data as text.

Member Data Documentation

eZXMLInputHandler::$AliasedHandler
private

Referenced by attribute().

eZXMLInputHandler::$AliasedType
private

Referenced by attribute().

eZXMLInputHandler::$ContentObjectAttribute
private
eZXMLInputHandler::$XMLData
private

Contains the XML data as text.

Referenced by xmlData().


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