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

__construct()

ODDDocument::__construct

(

array

$elements = null

)

Create a new ODD Document.

Parameters

array

$elements

Elements to add

Returns

void

Definition at line 34 of file ODDDocument.php.

Member Function Documentation

__toString()

ODDDocument::__toString

(

)

Magic function to generate valid ODD XML for this item.

Returns

string

Definition at line 116 of file ODDDocument.php.

addElement()

ODDDocument::addElement

(

ODD

$element

)

Add an element.

Parameters

ODD

$element

An ODD element

Returns

void

Definition at line 71 of file ODDDocument.php.

addElements()

ODDDocument::addElements

(

array

$elements

)

Add multiple elements at once.

Parameters

array

$elements

Array of ODD elements

Returns

void

Definition at line 85 of file ODDDocument.php.

current()

ODDDocument::current

(

)

Iterator interface.

See also

Iterator::current()

Returns

void

Definition at line 167 of file ODDDocument.php.

getElements()

ODDDocument::getElements

(

)

Return all elements.

Returns

array

Definition at line 96 of file ODDDocument.php.

getNumElements()

ODDDocument::getNumElements

(

)

Returns the number of elements.

Returns

int

Definition at line 60 of file ODDDocument.php.

getVersion()

ODDDocument::getVersion

(

)

Return the version of ODD being used.

Returns

string

Definition at line 51 of file ODDDocument.php.

key()

ODDDocument::key

(

)

Iterator interface.

See also

Iterator::key()

Returns

void

Definition at line 178 of file ODDDocument.php.

next()

ODDDocument::next

(

)

Iterator interface.

See also

Iterator::next()

Returns

void

Definition at line 189 of file ODDDocument.php.

rewind()

ODDDocument::rewind

(

)

Iterator interface.

See also

Iterator::rewind()

Returns

void

Definition at line 156 of file ODDDocument.php.

setWrapperFactory()

ODDDocument::setWrapperFactory

(

\ODDWrapperFactory

$factory

)

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

Parameters

\ODDWrapperFactory

$factory

The factory

Returns

void

Definition at line 107 of file ODDDocument.php.

valid()

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:

• engine/classes/ODDDocument.php