Class: GalleryComment

Source Location: /modules/comment/classes/GalleryComment.class

Class GalleryComment

Class Overview

A GalleryEntity for comments.

GalleryComments are basically just structured text objects.

Located in /modules/comment/classes/GalleryComment.class [line 49]

GalleryPersistent
   |
   --GalleryEntity
      |
      --GalleryChildEntity
         |
         --GalleryComment

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryChildEntity

GalleryChildEntity::$parentId

Inherited From GalleryEntity

GalleryEntity::$creationTimestamp

GalleryEntity::$entityType

GalleryEntity::$id

GalleryEntity::$isLinkable

GalleryEntity::$linkedEntity

GalleryEntity::$linkId

GalleryEntity::$modificationTimestamp

GalleryEntity::$onLoadHandlers

GalleryEntity::$serialNumber

Inherited From GalleryPersistent

GalleryPersistent::$_persistentStatus

Inherited From GalleryChildEntity

GalleryChildEntity::create()

Create this item in our persistent store

GalleryChildEntity::createLink()

GalleryChildEntity::createRoot()

Create a root level item.

GalleryChildEntity::fetchParent()

Get the parent instance

GalleryChildEntity::getClassName()

GalleryChildEntity::getParentId()

GalleryChildEntity::move()

Move this item to a new parent

GalleryChildEntity::setParentId()

Inherited From GalleryEntity

GalleryEntity::addOnLoadHandler()

Add onLoad handler.

GalleryEntity::create()

Create a new instance of this GalleryEntity in the persistent store

GalleryEntity::createLink()

Create a new linked version of this item into a new album

GalleryEntity::delete()

Delete this GalleryEntity

GalleryEntity::detachLink()

Detach this entity from the entity it is linked to by the simple expedient of overwriting over all non-null members with the equivalent from the link target.

GalleryEntity::getClassName()

Return the case sensitive name of this entity class. This is exactly what get_class() would return in PHP5. PHP4 is case-insensitive though so we must rely on it being set in each entity. The framework uses this as an index into entity related tables.

GalleryEntity::getCreationTimestamp()

GalleryEntity::getEntityType()

GalleryEntity::getId()

GalleryEntity::getIsLinkable()

GalleryEntity::getLinkedEntity()

GalleryEntity::getLinkId()

GalleryEntity::getModificationTimestamp()

GalleryEntity::getOnLoadHandlers()

GalleryEntity::getRenderer()

GalleryEntity::getSerialNumber()

GalleryEntity::hasOnLoadHandler()

Check for an onLoad handler.

GalleryEntity::isLinked()

Return true if this entity is linked to another

GalleryEntity::itemTypeName()

Return the name of this type of item.

GalleryEntity::onLoad()

This is called after an entity is loaded by the GalleryStorage subsystem.

GalleryEntity::onSave()

This is called after an entity is saved by the GalleryStorage subsystem.

GalleryEntity::refresh()

Refresh this item from the persistent store

GalleryEntity::removeOnLoadHandler()

Remove onLoad handler.

GalleryEntity::save()

Save the changes to this GalleryEntity.

GalleryEntity::setCreationTimestamp()

GalleryEntity::setEntityType()

GalleryEntity::setId()

GalleryEntity::setIsLinkable()

GalleryEntity::setLinkedEntity()

GalleryEntity::setLinkId()

GalleryEntity::setModificationTimestamp()

GalleryEntity::setOnLoadHandlers()

GalleryEntity::setSerialNumber()

Inherited From GalleryPersistent

GalleryPersistent::GalleryPersistent()

GalleryPersistent::clearPersistentFlag()

Clear a flag.

GalleryPersistent::getClassFile()

Return the relative path to the class for this entity

GalleryPersistent::getOriginalValue()

Return the original value of the given member.

GalleryPersistent::isModified()

Have we modified any data in this class?

GalleryPersistent::resetOriginalValues()

Reset all original values to the current values in the entity (or null if so specified).

GalleryPersistent::setPersistentFlag()

Set a flag.

GalleryPersistent::testPersistentFlag()

Test a flag.

[ Top ]

Property Summary

string	$author	Author of the comment. Only used for guest comments.
string	$comment	Text of the comment
int	$commenterId	Id of the commenter
int	$date	Date of the comment
string	$host	Commenter's host name or address
string	$publishStatus	Publication status of this comment.
string	$subject	Subject of the comment

[ Top ]

Method Summary

void	create()
void	getAuthor()
void	getClassName()
void	getComment()
void	getCommenterId()
void	getDate()
void	getHost()
void	getPublishStatus()
void	getSubject()
void	setAuthor()
void	setComment()
void	setCommenterId()
void	setDate()
void	setHost()
void	setPublishStatus()
void	setSubject()

[ Top ]

Properties

string $author [line 140]

Author of the comment. Only used for guest comments.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>author</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-external-access>FULL</member-external-access>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $comment [line 109]

Text of the comment

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>comment</member-name>
G2:	<member-type>TEXT</member-type>
G2:	<member-external-access>FULL</member-external-access>
G2:	<member-size>SMALL</member-size>
G2:	</member>

[ Top ]

int $commenterId [line 64]

Id of the commenter

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>commenterId</member-name>
G2:	<member-type>INTEGER</member-type>
G2:	<required/>
G2:	<member-size>LARGE</member-size>
G2:	</member>

[ Top ]

int $date [line 125]

Date of the comment

API Tags:

Access:

public

Information Tags:

G2:	<member-name>date</member-name>
G2:	<member>
G2:	<member-type>INTEGER</member-type>
G2:	<indexed/>
G2:	<member-external-access>READ</member-external-access>
G2:	<required/>
G2:	</member>

[ Top ]

string $host [line 79]

Commenter's host name or address

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>host</member-name>
G2:	<member-type>STRING</member-type>
G2:	<required/>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $publishStatus [line 158]

Publication status of this comment.

API Tags:

Access:	public
See:	modules/comment/module.inc for possible status values.

Information Tags:

G2:	<member-type>INTEGER</member-type>
G2:	<member-name>publishStatus</member-name>
G2:	<member>
G2:	<indexed/>
G2:	<required/>
G2:	</member>
G2:	<member-external-access>FULL</member-external-access>
G2:	<default>0</default>

[ Top ]

string $subject [line 94]

Subject of the comment

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>subject</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-external-access>FULL</member-external-access>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

Methods

create [line 170]

void create(

$parentId 
)

Parameters:

$parentId:

API Tags:

See:

GalleryEntity::create

Redefinition of:

GalleryChildEntity::create(): Create this item in our persistent store

[ Top ]

getAuthor [line 239]

void getAuthor(
)

[ Top ]

getClassName [line 163]

void getClassName(
)

API Tags:

See:

GalleryEntity::getClassName

Redefinition of:

GalleryChildEntity::getClassName()

[ Top ]

getComment [line 219]

void getComment(
)

[ Top ]

getCommenterId [line 195]

void getCommenterId(
)

[ Top ]

getDate [line 227]

void getDate(
)

[ Top ]

getHost [line 203]

void getHost(
)

[ Top ]

getPublishStatus [line 247]

void getPublishStatus(
)

[ Top ]

getSubject [line 211]

void getSubject(
)

[ Top ]

setAuthor [line 235]

void setAuthor(

$author 
)

Parameters:

$author:

[ Top ]

setComment [line 223]

void setComment(

$comment 
)

Parameters:

$comment:

[ Top ]

setCommenterId [line 199]

void setCommenterId(

$commenterId 
)

Parameters:

$commenterId:

[ Top ]

setDate [line 231]

void setDate(

$date 
)

Parameters:

$date:

[ Top ]

setHost [line 207]

void setHost(

$host 
)

Parameters:

$host:

[ Top ]

setPublishStatus [line 243]

void setPublishStatus(

$publishStatus 
)

Parameters:

$publishStatus:

[ Top ]

setSubject [line 215]

void setSubject(

$subject 
)

Parameters:

$subject:

[ Top ]

Documentation generated on Fri, 08 Oct 2010 04:54:19 -0700 by phpDocumentor 1.3.0RC6

	Comment Classes

[ class tree: Comment ] [ index: Comment ] [ all elements ]