ODD Class Reference

Inheritance diagram for ODD:

List of all members.

Public Member Functions
	__construct ()
	Construct an ODD document with initial values.
	getAttributes ()
	Returns an array of attributes.
	setAttribute ($key, $value)
	Sets an attribute.
	getAttribute ($key)
	Returns an attribute.
	setBody ($value)
	Sets the body of the ODD.
	getBody ()
	Gets the body of the ODD.
	setPublished ($time)
	Set the published time.
	getPublishedAsTime ()
	Return the published time as a unix timestamp.
	__toString ()
	Magic function to generate valid ODD XML for this item.
Protected Member Functions
	getTagName ()
	For serialisation, implement to return a string name of the tag eg "header" or "metadata".

---

Detailed Description

Definition at line 9 of file ODD.php.

---

Constructor & Destructor Documentation

ODD::__construct

(

)

Construct an ODD document with initial values.

Definition at line 23 of file ODD.php.

---

Member Function Documentation

ODD::__toString

(

)

Magic function to generate valid ODD XML for this item.

Returns:

string

Definition at line 115 of file ODD.php.

ODD::getAttribute

(

$

key

)

Returns an attribute.

Parameters:

string

$key Name

Returns:

mixed

Definition at line 55 of file ODD.php.

ODD::getAttributes

(

)

Returns an array of attributes.

Returns:

array

Definition at line 32 of file ODD.php.

ODD::getBody

(

)

Gets the body of the ODD.

Returns:

mixed

Definition at line 79 of file ODD.php.

ODD::getPublishedAsTime

(

)

Return the published time as a unix timestamp.

Returns:

int or false on failure.

Definition at line 99 of file ODD.php.

ODD::getTagName

(

)

[abstract, protected]

For serialisation, implement to return a string name of the tag eg "header" or "metadata".

Returns:

string

Reimplemented in ODDEntity, ODDMetaData, and ODDRelationship.

ODD::setAttribute	(	$	key,
		$	value
	)

Sets an attribute.

Parameters:

	string	$key Name
	mixed	$value Value

Returns:

void

Definition at line 44 of file ODD.php.

ODD::setBody

(

$

value

)

Sets the body of the ODD.

Parameters:

mixed

$value Value

Returns:

void

Definition at line 70 of file ODD.php.

ODD::setPublished

(

$

time

)

Set the published time.

Parameters:

int

$time Unix timestamp

Returns:

void

Definition at line 90 of file ODD.php.

---

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

• engine/classes/ODD.php