ODD Class Reference

Inheritance diagram for ODD:

Public Member Functions
	__construct ()
	Construct an ODD document with initial values. More...
	getAttributes ()
	Returns an array of attributes. More...
	setAttribute ($key, $value)
	Sets an attribute. More...
	getAttribute ($key)
	Returns an attribute. More...
	setBody ($value)
	Sets the body of the ODD. More...
	getBody ()
	Gets the body of the ODD. More...
	setPublished ($time)
	Set the published time. More...
	getPublishedAsTime ()
	Return the published time as a unix timestamp. More...
	__toString ()
	Magic function to generate valid ODD XML for this item. More...

Protected Member Functions
	getTagName ()
	For serialisation, implement to return a string name of the tag eg "header" or "metadata". More...

Detailed Description

Definition at line 9 of file ODD.php.

Constructor & Destructor Documentation

__construct()

ODD::__construct

(

)

Construct an ODD document with initial values.

Definition at line 23 of file ODD.php.

Member Function Documentation

__toString()

ODD::__toString

(

)

Magic function to generate valid ODD XML for this item.

Returns

string

Definition at line 115 of file ODD.php.

getAttribute()

ODD::getAttribute

(

$key

)

Returns an attribute.

Parameters

string

$key

Name

Returns

mixed

Definition at line 55 of file ODD.php.

getAttributes()

ODD::getAttributes

(

)

Returns an array of attributes.

Returns

array

Definition at line 32 of file ODD.php.

getBody()

ODD::getBody

(

)

Gets the body of the ODD.

Returns

mixed

Definition at line 79 of file ODD.php.

getPublishedAsTime()

ODD::getPublishedAsTime

(

)

Return the published time as a unix timestamp.

Returns

int or false on failure.

Definition at line 99 of file ODD.php.

getTagName()

ODD::getTagName ( )

abstractprotected

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

Returns

string

Reimplemented in ODDRelationship, ODDMetaData, and ODDEntity.

setAttribute()

ODD::setAttribute	(		$key,
			$value
	)

Sets an attribute.

Parameters

string	$key	Name
mixed	$value	Value

Returns

void

Definition at line 44 of file ODD.php.

setBody()

ODD::setBody

(

$value

)

Sets the body of the ODD.

Parameters

mixed

$value

Value

Returns

void

Definition at line 70 of file ODD.php.

setPublished()

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