dmComment Class Reference

Inheritance diagram for dmComment:
dmModel

Public Member Functions


Detailed Description

Definition at line 21 of file dmComment.class.php.


Constructor & Destructor Documentation

dmComment::__construct ( id = null  ) 

If supplied and is a valid comment ID, automatically populates the comment's properties from the HTTP API.

Otherwise instantiates an empty dmComment object.

Parameters:
id 
Exceptions:
dmUnavailableCommentException 
Since:
0.1

Definition at line 36 of file dmComment.class.php.


Member Function Documentation

dmComment::getDateTime (  )  [final]

Alias of getTimestamp().

Returns:
string The date/time that the comment was posted, as a dmDateTime object.
Since:
0.1
Deprecated:
Use getTimestamp() instead

Definition at line 52 of file dmComment.class.php.

dmComment::getEmail (  )  [final]
Returns:
The email address supplied by the poster of the comment, as a string.
Since:
0.1

Definition at line 62 of file dmComment.class.php.

Referenced by dmObject::addComment().

dmComment::getID (  )  [final]
Returns:
int
Since:
0.1

Definition at line 92 of file dmComment.class.php.

dmComment::getName (  )  [final]
Returns:
The name supplied by the poster of the comment.
Since:
0.1

Definition at line 110 of file dmComment.class.php.

Referenced by dmObject::addComment().

dmComment::getObject (  )  [final]
Returns:
The dmObject object with which the dmComment is associated

Definition at line 135 of file dmComment.class.php.

dmComment::getText (  )  [final]
Returns:
string
Since:
0.1

Definition at line 162 of file dmComment.class.php.

Referenced by dmObject::addComment().

dmComment::getTimestamp (  )  [final]

Alias of dmComment::getDateTime().

Returns:
dmDateTime The date/time that the comment was saved to the data store.
Since:
0.1

Definition at line 182 of file dmComment.class.php.

Referenced by getDateTime().

dmComment::setEmail ( email  )  [final]
Parameters:
email 
Exceptions:
dmInvalidEmailException 
Since:
0.1

Definition at line 80 of file dmComment.class.php.

Referenced by getEmail().

dmComment::setID ( id  )  [final]
Parameters:
int id
Since:
0.1

Definition at line 101 of file dmComment.class.php.

Referenced by __construct().

dmComment::setName ( name  )  [final]
Parameters:
name 
Since:
0.1

Definition at line 127 of file dmComment.class.php.

Referenced by getName().

dmComment::setObject ( dmObject obj  )  [final]
Parameters:
dmObject obj

Definition at line 153 of file dmComment.class.php.

dmComment::setText ( text  )  [final]
Parameters:
text 
Since:
0.1

Definition at line 199 of file dmComment.class.php.

Referenced by getText().


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

Generated on Fri Aug 20 13:16:50 2010 for dmBridge PHP API by  doxygen 1.6.1