Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
ODDDocument Class Reference
Inheritance diagram for ODDDocument:

Public Member Functions

 __construct (array $elements=null)
 Create a new ODD Document. More...
 
 getVersion ()
 Return the version of ODD being used. More...
 
 getNumElements ()
 Returns the number of elements. More...
 
 addElement (ODD $element)
 Add an element. More...
 
 addElements (array $elements)
 Add multiple elements at once. More...
 
 getElements ()
 Return all elements. More...
 
 setWrapperFactory (\ODDWrapperFactory $factory)
 Set an optional wrapper factory to optionally embed the ODD document in another format. More...
 
 __toString ()
 Magic function to generate valid ODD XML for this item. More...
 
 rewind ()
 Iterator interface. More...
 
 current ()
 Iterator interface. More...
 
 key ()
 Iterator interface. More...
 
 next ()
 Iterator interface. More...
 
 valid ()
 Iterator interface. More...
 

Detailed Description

Definition at line 9 of file ODDDocument.php.

Constructor & Destructor Documentation

ODDDocument::__construct ( array  $elements = null)

Create a new ODD Document.

Parameters
array$elementsElements to add
Returns
void

Definition at line 34 of file ODDDocument.php.

Member Function Documentation

ODDDocument::__toString ( )

Magic function to generate valid ODD XML for this item.

Returns
string

Definition at line 116 of file ODDDocument.php.

ODDDocument::addElement ( ODD  $element)

Add an element.

Parameters
ODD$elementAn ODD element
Returns
void

Definition at line 71 of file ODDDocument.php.

ODDDocument::addElements ( array  $elements)

Add multiple elements at once.

Parameters
array$elementsArray of ODD elements
Returns
void

Definition at line 85 of file ODDDocument.php.

ODDDocument::current ( )

Iterator interface.

See Also
Iterator::current()
Returns
void

Definition at line 167 of file ODDDocument.php.

ODDDocument::getElements ( )

Return all elements.

Returns
array

Definition at line 96 of file ODDDocument.php.

ODDDocument::getNumElements ( )

Returns the number of elements.

Returns
int

Definition at line 60 of file ODDDocument.php.

ODDDocument::getVersion ( )

Return the version of ODD being used.

Returns
string

Definition at line 51 of file ODDDocument.php.

ODDDocument::key ( )

Iterator interface.

See Also
Iterator::key()
Returns
void

Definition at line 178 of file ODDDocument.php.

ODDDocument::next ( )

Iterator interface.

See Also
Iterator::next()
Returns
void

Definition at line 189 of file ODDDocument.php.

ODDDocument::rewind ( )

Iterator interface.

See Also
Iterator::rewind()
Returns
void

Definition at line 156 of file ODDDocument.php.

ODDDocument::setWrapperFactory ( \ODDWrapperFactory  $factory)

Set an optional wrapper factory to optionally embed the ODD document in another format.

Parameters
\ODDWrapperFactory$factoryThe factory
Returns
void

Definition at line 107 of file ODDDocument.php.

ODDDocument::valid ( )

Iterator interface.

See Also
Iterator::valid()
Returns
void

Definition at line 200 of file ODDDocument.php.


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