Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Comment Class Reference
Inheritance diagram for Comment:
DataObject

Public Member Functions

 Comment ()
 
 getBody ()
 
 getChildCommentCount ()
 
getChildren ()
 
 getDateModified ()
 
 getDatePosted ()
 
 getParentCommentId ()
 
 getPosterEmail ()
 
 getPosterIP ()
 
 getPosterName ()
 
 getSubmissionId ()
 
 getTitle ()
 
 getUser ()
 
 setBody ($body)
 
 setChildCommentCount ($childCommentCount)
 
 setChildren (&$children)
 
 setDateModified ($dateModified)
 
 setDatePosted ($datePosted)
 
 setParentCommentId ($parentCommentId)
 
 setPosterEmail ($posterEmail)
 
 setPosterIP ($posterIP)
 
 setPosterName ($posterName)
 
 setSubmissionId ($submissionId)
 
 setTitle ($title)
 
 setUser ($user)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Class for public Comment associated with submission.

See Also
CommentDAO

Definition at line 22 of file Comment.inc.php.

Member Function Documentation

Comment::Comment ( )

Constructor.

Definition at line 26 of file Comment.inc.php.

References PKPRequest\getRemoteAddr(), and setPosterIP().

Comment::getBody ( )

get comment body

Returns
string

Definition at line 161 of file Comment.inc.php.

References DataObject\getData().

Comment::getChildCommentCount ( )

get number of child comments

Returns
int

Definition at line 35 of file Comment.inc.php.

References DataObject\getData().

& Comment::getChildren ( )

get child comments (if fetched using recursive option)

Returns
array

Definition at line 209 of file Comment.inc.php.

References DataObject\getData().

Comment::getDateModified ( )

get date modified

Returns
date

Definition at line 193 of file Comment.inc.php.

References DataObject\getData().

Comment::getDatePosted ( )

get date posted

Returns
date

Definition at line 177 of file Comment.inc.php.

References DataObject\getData().

Comment::getParentCommentId ( )

get parent comment id

Returns
int

Definition at line 51 of file Comment.inc.php.

References DataObject\getData().

Comment::getPosterEmail ( )

get poster email

Definition at line 113 of file Comment.inc.php.

References DataObject\getData().

Comment::getPosterIP ( )

get posterIP

Returns
string

Definition at line 129 of file Comment.inc.php.

References DataObject\getData().

Comment::getPosterName ( )

get poster name

Definition at line 98 of file Comment.inc.php.

References DataObject\getData().

Comment::getSubmissionId ( )

Get submission id

Returns
int

Definition at line 67 of file Comment.inc.php.

References DataObject\getData().

Comment::getTitle ( )

get title

Returns
string

Definition at line 145 of file Comment.inc.php.

References DataObject\getData().

Comment::getUser ( )

get user object

Returns
object

Definition at line 83 of file Comment.inc.php.

References DataObject\getData().

Comment::setBody (   $body)

set comment body

Parameters
$bodystring

Definition at line 169 of file Comment.inc.php.

References DataObject\setData().

Comment::setChildCommentCount (   $childCommentCount)

set number of child comments

Parameters
$childCommentCountint

Definition at line 43 of file Comment.inc.php.

References DataObject\setData().

Comment::setChildren ( $children)

set child comments

Parameters
$childrenarray

Definition at line 218 of file Comment.inc.php.

References DataObject\setData().

Comment::setDateModified (   $dateModified)

set date modified

Parameters
$dateModifieddate

Definition at line 201 of file Comment.inc.php.

References DataObject\setData().

Comment::setDatePosted (   $datePosted)

set date posted

Parameters
$datePosteddate

Definition at line 185 of file Comment.inc.php.

References DataObject\setData().

Comment::setParentCommentId (   $parentCommentId)

set parent comment id

Parameters
$parentCommentIdint

Definition at line 59 of file Comment.inc.php.

References DataObject\setData().

Comment::setPosterEmail (   $posterEmail)

set poster email

Parameters
$posterEmailstring

Definition at line 121 of file Comment.inc.php.

References DataObject\setData().

Comment::setPosterIP (   $posterIP)

set posterIP

Parameters
$posterIPstring

Definition at line 137 of file Comment.inc.php.

References DataObject\setData().

Referenced by Comment().

Comment::setPosterName (   $posterName)

set poster name

Parameters
$posterNamestring

Definition at line 106 of file Comment.inc.php.

References DataObject\setData().

Comment::setSubmissionId (   $submissionId)

Set submission id

Parameters
$submissionIdint

Definition at line 75 of file Comment.inc.php.

References DataObject\setData().

Comment::setTitle (   $title)

set title

Parameters
$titlestring

Definition at line 153 of file Comment.inc.php.

References DataObject\setData().

Comment::setUser (   $user)

set user object

Parameters
$userobject

Definition at line 91 of file Comment.inc.php.

References DataObject\setData().


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