Docs For Class NarutoDO

Description

This is a base class for data objects including Forum, Topic and User.

Located in /classes/narutoDO.php (line 15)

Direct descendents

Class	Description
NarutoForum	This class encapulates a Forum data object.
NarutoTopic	This class defined the topic object.
NarutoUser	This class defines the forum user object.

Method Summary

NarutoDO NarutoDO (string $id, string $name, string $url)

void clearAttributes ()

mixed getAttribute (string $attribute, [mixed $default_val = null])

array getAttributes ()

string getId ()

string getName ()

string getUrl ()

boolean setAttribute (string $attribute, mixed $value)

boolean setAttributes (array $attributes)

void setId (string $id)

void setName (string $name)

void setUrl (string $url)

Methods

Constructor NarutoDO (line 25)

Contructor.

access: public

NarutoDO NarutoDO (string $id, string $name, string $url)

string $id: the id.
string $name: the name.
string $url: the HTTP url.

clearAttributes (line 161)

Removes all attributes.

access: public

void clearAttributes ()

getAttribute (line 99)

Returns the value of a attribute. The value will be a string or numeric.

return: the value found or the value of $default_val if not found.
access: public

mixed getAttribute (string $attribute, [mixed $default_val = null])

string $attribute: The proprty being set.
mixed $default_val: The value to use is the attribute is not found.

getAttributes (line 137)

Returns all of the attributes.

return: the attribute map
access: public

array getAttributes ()

getId (line 37)

Get the id.

return: the id.
access: public

string getId ()

getName (line 57)

Get the id.

return: the name.
access: public

string getName ()

getUrl (line 77)

Get the url.

return: the url.
access: public

string getUrl ()

setAttribute (line 114)

Adds or updates a attribute. The value has to be a string or numeric.

return: true if attribute was set
access: public

boolean setAttribute (string $attribute, mixed $value)

string $attribute: The proprty being set.
mixed $value: The value to set the peoperty to. Value "null" will remove attribute.

setAttributes (line 149)

Sets all of the attributes at once removing all existing attributes.

return: true if every attribute was set, false if at least one attribute was not.
access: public

boolean setAttributes (array $attributes)

array $attributes: the attribute map to use.

setId (line 47)

Set the id.

access: public

void setId (string $id)

string $id: the new id.

setName (line 67)

Set the name.

access: public

void setName (string $name)

string $name: the new name.

setUrl (line 87)

Set the url.

access: public

void setUrl (string $url)

string $url: the new HTTP url.