eZ Publish  [4.2]
eZXMLOutputHandler Class Reference

The class eZXMLOutputHandler does. More...

+ Inheritance diagram for eZXMLOutputHandler:

List of all members.

Public Member Functions

 attribute ($name)
 attributes ()
 callTagInitHandler ($handlerName, $element, &$attributes, &$siblingParams, &$parentParams)
 callTagRenderHandler ($handlerName, $element, $childrenOutput, $vars)
 eZXMLOutputHandler ($xmlData, $aliasedType, $contentObjectAttribute=null)
 getAttributeValueArray ($tagName, $attributeName)
 hasAttribute ($name)
 isValid ()
 outputTag ($element, &$siblingParams, $parentParams=array())
outputText ()
 prefetch ()
 renderAll ($element, $childrenOutput, $vars)
 renderTag ($element, $content, $vars)
viewTemplateName ()
viewTemplateSuffix (&$contentobjectAttribute)
 xmlData ()

Public Attributes

 $AliasedHandler
 $AliasedType
 $AllowMultipleSpaces = false
 $AllowNumericEntities = false
 $ContentObjectAttribute
 $Document
 $LinkArray = array()
 Contains the URL's for <link> tags hashed by ID.
 $NestingLevel = 0
 $NodeArray = array()
 Contains the Nodes hashed by ID.
 $ObjectArray = array()
 Contains the Objects hashed by ID.
 $ObjectAttributeID
 $Output = ''
 $OutputTags = array()
 $Res
 $TemplatesPath = 'design:content/datatype/view/ezxmltags/'
 $TemplateURI = ''
 $Tpl
 $XMLData
 Contains the XML data as text.
 $XMLSchema

Detailed Description

The class eZXMLOutputHandler does.

Definition at line 42 of file ezxmloutputhandler.php.


Member Function Documentation

eZXMLOutputHandler::attribute ( name)
Returns:
the value of the attribute $name if it exists, if not returns null.

Definition at line 95 of file ezxmloutputhandler.php.

eZXMLOutputHandler::attributes ( )
Returns:
an array with attribute names.

Definition at line 76 of file ezxmloutputhandler.php.

Referenced by hasAttribute().

eZXMLOutputHandler::callTagInitHandler ( handlerName,
element,
&$  attributes,
&$  siblingParams,
&$  parentParams 
)

Definition at line 617 of file ezxmloutputhandler.php.

Referenced by outputTag().

eZXMLOutputHandler::callTagRenderHandler ( handlerName,
element,
childrenOutput,
vars 
)

Definition at line 632 of file ezxmloutputhandler.php.

Referenced by outputTag().

eZXMLOutputHandler::eZXMLOutputHandler ( xmlData,
aliasedType,
contentObjectAttribute = null 
)

Constructor

Definition at line 47 of file ezxmloutputhandler.php.

Referenced by eZPlainXMLOutput\eZPlainXMLOutput(), and eZXHTMLXMLOutput\eZXHTMLXMLOutput().

eZXMLOutputHandler::getAttributeValueArray ( tagName,
attributeName 
)

Definition at line 300 of file ezxmloutputhandler.php.

Referenced by prefetch().

eZXMLOutputHandler::hasAttribute ( name)
Returns:
true if the attribute $name exists.

Definition at line 87 of file ezxmloutputhandler.php.

eZXMLOutputHandler::isValid ( )
Returns:
true if the output handler is considered valid, if not the handler will not be used.
Note:
Default returns true

Definition at line 150 of file ezxmloutputhandler.php.

eZXMLOutputHandler::outputTag ( element,
&$  siblingParams,
parentParams = array() 
)

Definition at line 324 of file ezxmloutputhandler.php.

Referenced by outputText().

& eZXMLOutputHandler::outputText ( )

Returns the output text representation of the XML structure Default implementation uses default mechanism of rules and tag handlers to render tags.

Reimplemented in eZPlainXMLOutput.

Definition at line 177 of file ezxmloutputhandler.php.

Referenced by attribute().

eZXMLOutputHandler::prefetch ( )

Definition at line 227 of file ezxmloutputhandler.php.

Referenced by outputText().

eZXMLOutputHandler::renderAll ( element,
childrenOutput,
vars 
)

Definition at line 606 of file ezxmloutputhandler.php.

Referenced by eZXHTMLXMLOutput\renderCustom().

eZXMLOutputHandler::renderTag ( element,
content,
vars 
)
& eZXMLOutputHandler::viewTemplateName ( )
Returns:
the template name for this input handler, includes the edit suffix if any.

Definition at line 134 of file ezxmloutputhandler.php.

Referenced by attribute().

& eZXMLOutputHandler::viewTemplateSuffix ( &$  contentobjectAttribute) [pure virtual]
Returns:
the suffix for the attribute template, if false it is ignored.

Definition at line 159 of file ezxmloutputhandler.php.

Referenced by viewTemplateName().

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

Definition at line 168 of file ezxmloutputhandler.php.

Referenced by eZPlainXMLOutput\outputText().


Member Data Documentation

eZXMLOutputHandler::$AliasedHandler

Definition at line 671 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$AliasedType

Definition at line 670 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$AllowMultipleSpaces = false

Definition at line 678 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$AllowNumericEntities = false

Definition at line 679 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$ContentObjectAttribute

Definition at line 681 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$Document

Definition at line 666 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$LinkArray = array()

Contains the URL's for <link> tags hashed by ID.

Definition at line 685 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$NestingLevel = 0

Definition at line 691 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$NodeArray = array()

Contains the Nodes hashed by ID.

Definition at line 689 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$ObjectArray = array()

Contains the Objects hashed by ID.

Definition at line 687 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$ObjectAttributeID

Definition at line 682 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$Output = ''

Definition at line 673 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$OutputTags = array()

Reimplemented in eZXHTMLXMLOutput.

Definition at line 659 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$Res

Definition at line 676 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$TemplatesPath = 'design:content/datatype/view/ezxmltags/'

Reimplemented in eZPDFXMLOutput.

Definition at line 662 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$TemplateURI = ''

Definition at line 675 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$Tpl

Definition at line 674 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$XMLData

Contains the XML data as text.

Definition at line 665 of file ezxmloutputhandler.php.

eZXMLOutputHandler::$XMLSchema

Definition at line 668 of file ezxmloutputhandler.php.


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