Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Comment Class Reference
Inheritance diagram for Comment:
DataObject

Public Member Functions

 Comment ()
 
 getBody ()
 
 getChildCommentCount ()
 
getChildren ()
 
 getCommentId ()
 
 getDateModified ()
 
 getDatePosted ()
 
 getParentCommentId ()
 
 getPosterEmail ()
 
 getPosterIP ()
 
 getPosterName ()
 
 getSubmissionId ()
 
 getTitle ()
 
 getUser ()
 
 setBody ($body)
 
 setChildCommentCount ($childCommentCount)
 
 setChildren (&$children)
 
 setCommentId ($commentId)
 
 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 ($callHooks=true)
 
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()
 

Detailed Description

Class for public Comment associated with submission.

See Also
CommentDAO

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

Member Function Documentation

Comment::Comment ( )

Constructor.

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

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

Comment::getBody ( )

get comment body

Returns
string

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

References DataObject\getData().

Comment::getChildCommentCount ( )

get number of child comments

Returns
int

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

References DataObject\getData().

& Comment::getChildren ( )

get child comments (if fetched using recursive option)

Returns
array

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

References DataObject\getData().

Comment::getCommentId ( )

Get submission comment id

Returns
int

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

References DataObject\getId(), and Config\getVar().

Comment::getDateModified ( )

get date modified

Returns
date

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

References DataObject\getData().

Comment::getDatePosted ( )

get date posted

Returns
date

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

References DataObject\getData().

Comment::getParentCommentId ( )

get parent comment id

Returns
int

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

References DataObject\getData().

Comment::getPosterEmail ( )

get poster email

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

References DataObject\getData().

Comment::getPosterIP ( )

get posterIP

Returns
string

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

References DataObject\getData().

Comment::getPosterName ( )

get poster name

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

References DataObject\getData().

Comment::getSubmissionId ( )

Get submission id

Returns
int

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

References DataObject\getData().

Comment::getTitle ( )

get title

Returns
string

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

References DataObject\getData().

Comment::getUser ( )

get user object

Returns
object

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

References DataObject\getData().

Comment::setBody (   $body)

set comment body

Parameters
$bodystring

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

References DataObject\setData().

Comment::setChildCommentCount (   $childCommentCount)

set number of child comments

Parameters
$childCommentCountint

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

References DataObject\setData().

Comment::setChildren ( $children)

set child comments

Parameters
$childrenarray

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

References DataObject\setData().

Comment::setCommentId (   $commentId)

Set submission comment id

Parameters
$commentIdint

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

References Config\getVar(), and DataObject\setId().

Comment::setDateModified (   $dateModified)

set date modified

Parameters
$dateModifieddate

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

References DataObject\setData().

Comment::setDatePosted (   $datePosted)

set date posted

Parameters
$datePosteddate

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

References DataObject\setData().

Comment::setParentCommentId (   $parentCommentId)

set parent comment id

Parameters
$parentCommentIdint

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

References DataObject\setData().

Comment::setPosterEmail (   $posterEmail)

set poster email

Parameters
$posterEmailstring

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

References DataObject\setData().

Comment::setPosterIP (   $posterIP)

set posterIP

Parameters
$posterIPstring

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

References DataObject\setData().

Referenced by Comment().

Comment::setPosterName (   $posterName)

set poster name

Parameters
$posterNamestring

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

References DataObject\setData().

Comment::setSubmissionId (   $submissionId)

Set submission id

Parameters
$submissionIdint

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

References DataObject\setData().

Comment::setTitle (   $title)

set title

Parameters
$titlestring

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

References DataObject\setData().

Comment::setUser (   $user)

set user object

Parameters
$userobject

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

References DataObject\setData().


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