ODDDocument Class Reference

List of all members.

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

---

Detailed Description

Definition at line 8 of file ODDDocument.php.

---

Constructor & Destructor Documentation

ODDDocument::__construct

(

array $

elements = NULL

)

Create a new ODD Document.

Parameters:

array

$elements Elements to add

Returns:

void

Definition at line 33 of file ODDDocument.php.

---

Member Function Documentation

ODDDocument::__toString

(

)

Magic function to generate valid ODD XML for this item.

Returns:

string

Definition at line 115 of file ODDDocument.php.

ODDDocument::addElement

(

ODD $

element

)

Add an element.

Parameters:

ODD

$element An ODD element

Returns:

void

Definition at line 70 of file ODDDocument.php.

ODDDocument::addElements

(

array $

elements

)

Add multiple elements at once.

Parameters:

array

$elements Array of ODD elements

Returns:

void

Definition at line 84 of file ODDDocument.php.

ODDDocument::current

(

)

Iterator interface.

See also:

Iterator::current()

Returns:

void

Definition at line 166 of file ODDDocument.php.

ODDDocument::getElements

(

)

Return all elements.

Returns:

array

Definition at line 95 of file ODDDocument.php.

ODDDocument::getNumElements

(

)

Returns the number of elements.

Returns:

int

Definition at line 59 of file ODDDocument.php.

ODDDocument::getVersion

(

)

Return the version of ODD being used.

Returns:

string

Definition at line 50 of file ODDDocument.php.

ODDDocument::key

(

)

Iterator interface.

See also:

Iterator::key()

Returns:

void

Definition at line 177 of file ODDDocument.php.

ODDDocument::next

(

)

Iterator interface.

See also:

Iterator::next()

Returns:

void

Definition at line 188 of file ODDDocument.php.

ODDDocument::rewind

(

)

Iterator interface.

See also:

Iterator::rewind()

Returns:

void

Definition at line 155 of file ODDDocument.php.

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 106 of file ODDDocument.php.

ODDDocument::valid

(

)

Iterator interface.

See also:

Iterator::valid()

Returns:

void

Definition at line 199 of file ODDDocument.php.

---

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

• engine/classes/ODDDocument.php