ElggComment Class Reference

Inheritance diagram for ElggComment:

Public Member Functions
	restore (bool $recursive=true)
	{Restore the entity. Parameters bool $recursive Recursively restores all entities trashed with the entity? Returns bool Since 6.0 } More...
	canComment (int $user_guid=0)
	Can a user comment on an entity?@tip Can be overridden by registering for the 'permissions_check:comment', '<entity type>' event. Parameters int $user_guid User guid (default is logged in user) Returns bool More...
	isCreatedByContentOwner ()
	Is this comment created by the same owner as the content of the item being commented on. More...
	getLevel ()
	Get the depth level of the comment. More...
	getThreadGUID ()
	Return the thread GUID this comment is a part of. More...
	getThreadEntity ()
	Return the thread (top-level) comment. More...
Public Member Functions inherited from ElggObject
	getDisplayName ()
	{Get the entity's display name. Returns string The title or name of this entity. } More...
	setDisplayName (string $display_name)
	{Sets the title or name of this entity. Parameters string $display_name The title or name of this entity. Returns void } More...
Public Member Functions inherited from ElggEntity
	__construct (?\stdClass $row=null)
	Create a new entity. More...
	__clone ()
	Clone an entity. More...
	__set ($name, $value)
	Set an attribute or metadata value for this entity. More...
	getOriginalAttributes ()
	Get the original values of attribute(s) that have been modified since the entity was persisted. More...
	__get ($name)
	Get an attribute or metadata value. More...
	getVolatileData (string $name)
	Get a piece of volatile (non-persisted) data on this entity. More...
	setVolatileData (string $name, $value)
	Set a piece of volatile (non-persisted) data on this entity. More...
	removeAllRelatedRiverItems ()
	Removes all river items related to this entity. More...
	countComments ()
	Count the number of comments attached to this entity. More...
	hasAccess (int $user_guid=0)
	Check if the given user has access to this entity. More...
	canEdit (int $user_guid=0)
	Can a user edit this entity? More...
	canDelete (int $user_guid=0)
	Can a user delete this entity? More...
	canWriteToContainer (int $user_guid=0, string $type='', string $subtype='')
	Can a user add an entity to this container. More...
	canAnnotate (int $user_guid=0, string $annotation_name='')
	Can a user annotate an entity? More...
	getGUID ()
	Returns the guid. More...
	getType ()
	Returns the entity type. More...
	setSubtype (string $subtype)
	Set the subtype of the entity. More...
	getSubtype ()
	Get the entity subtype. More...
	getOwnerGUID ()
	Get the guid of the entity's owner. More...
	getOwnerEntity ()
	Gets the \ElggEntity that owns this entity. More...
	setContainerGUID (int $container_guid)
	Set the container for this object. More...
	getContainerGUID ()
	Gets the container GUID for this entity. More...
	getContainerEntity ()
	Get the container entity for this object. More...
	getTimeUpdated ()
	Returns the UNIX epoch time that this entity was last updated. More...
	getURL ()
	Gets the URL for this entity. More...
	save ()
	Save this data to the appropriate database table. Returns bool More...
	disable (string $reason='', bool $recursive=true)
	Disable this entity. More...
	enable (bool $recursive=true)
	Enable the entity. More...
	isEnabled ()
	Is this entity enabled? More...
	delete (bool $recursive=true, ?bool $persistent=null)
	Deletes the entity. More...
	isDeleted ()
	Is the entity marked as deleted. More...
	toObject (array $params=[])
	Export an entity. More...
	setLatLong (float $lat, float $long)
	Set latitude and longitude metadata tags for a given entity. More...
	getLatitude ()
	Return the entity's latitude. More...
	getLongitude ()
	Return the entity's longitude. More...
	getSystemLogID ()
	{Return an identification for the object for storage in the system log.This id must be an integer. Unsaved implementations should return 0. Returns int } More...
	getObjectFromID (int $id)
	For a given ID, return the object associated with it. More...
	updateLastAction (?int $posted=null)
	Update the last_action column in the entities table. More...
	updateTimeDeleted (?int $deleted=null)
	Update the time_deleted column in the entities table. More...
	disableCaching ()
	Disable runtime caching for entity. More...
	enableCaching ()
	Enable runtime caching for entity. More...
	isCacheable ()
	Is entity cacheable in the runtime cache. More...
	cache ()
	Cache the entity in a session cache. More...
	invalidateCache ()
	Invalidate cache for entity. More...
	hasCapability (string $capability)
	Checks a specific capability is enabled for the entity type/subtype. More...
	getFields ()
	Helper function to easily retrieve form fields for this entity. More...
Public Member Functions inherited from ElggData
	__isset ($name)
	Test if property is set either as an attribute or metadata. More...
	__unset ($name)
	Unset a property from metadata or attribute. More...
	delete ()
	Delete this data. More...
	getTimeCreated ()
	Returns the UNIX epoch time that this entity was created. More...
	rewind ()
	Iterator interface. More...
	current ()
	Iterator interface. More...
	key ()
	Iterator interface. More...
	next ()
	Iterator interface. More...
	valid ()
	Iterator interface. More...
	offsetSet ($offset, $value)
	Array access interface. More...
	offsetGet ($offset)
	Array access interface. More...
	offsetUnset ($offset)
	Array access interface. More...
	offsetExists ($offset)
	Array access interface. More...
	getID ()
	{Get unique item identifier within a collection. Returns string|int } More...
	getPriority ()
	{Get priority (weight) of the item within a collection. Returns int } More...
	__serialize ()
	Called during serialization. More...
	__unserialize (array $data)
	Called during unserialization. More...

Protected Member Functions
	initializeAttributes ()
	Set subtype to comment. More...
	persistentDelete (bool $recursive=true)
	{Permanently delete the entity from the database. Parameters bool $recursive If true (default) then all entities which are owned or contained by $this will also be deleted. Returns bool Since 6.0 } More...
	trash (bool $recursive=true)
	{Move the entity to the trash. Parameters bool $recursive If true (default) then all entities which are owned or contained by $this will also be trashed. Returns bool Since 6.0 } More...
	deleteThreadedComments (bool $recursive, bool $persistent)
	Delete threaded child comments on this comment. More...
Protected Member Functions inherited from ElggObject
	prepareObject (\Elgg\Export\Entity $object)
	{Prepare an object copy for toObject() Parameters \Elgg\Export\Entity $object Object representation of the entity Returns \Elgg\Export\Entity } More...
Protected Member Functions inherited from ElggEntity
	create ()
	Create a new entry in the entities table. More...
	update ()
	Update the entity in the database. More...
	load (stdClass $row)
	Loads attributes from the entities table into the object. More...
Protected Member Functions inherited from ElggData
	getDatabase ()
	Provides a pointer to the database object. More...

Additional Inherited Members
Static Public Member Functions inherited from ElggEntity
static	getDefaultFields ()
	Returns a default set of fields to be used for forms related to this entity. More...
Public Attributes inherited from ElggEntity
const	PRIMARY_ATTR_NAMES
Protected Attributes inherited from ElggEntity
const	INTEGER_ATTR_NAMES
	$volatile = []
	$orig_attributes = []
	$_is_cacheable = true
Protected Attributes inherited from ElggData
	$attributes = []
	$valid = false

Detailed Description

Examples

/root/Elgg/engine/lib/views.php.

Definition at line 11 of file ElggComment.php.

Member Function Documentation

canComment()

ElggComment::canComment

(

int

$user_guid = 0

)

Can a user comment on an entity?@tip Can be overridden by registering for the 'permissions_check:comment', '<entity type>' event.

Parameters

int

$user_guid

User guid (default is logged in user)

Returns

bool

Reimplemented from ElggEntity.

Definition at line 119 of file ElggComment.php.

deleteThreadedComments()

ElggComment::deleteThreadedComments ( bool  $recursive, bool  $persistent  )

protected

Delete threaded child comments on this comment.

Parameters

bool	$recursive	recursive delete contained entities
bool	$persistent	persistently remove the threaded comments

Returns

void

Since

6.0

Definition at line 92 of file ElggComment.php.

getLevel()

ElggComment::getLevel

(

)

Get the depth level of the comment.

Returns

int 1: toplevel, 2: first level, etc

Since

4.1

Definition at line 155 of file ElggComment.php.

getThreadEntity()

ElggComment::getThreadEntity

(

)

Return the thread (top-level) comment.

Returns

\ElggComment

Since

4.1

Definition at line 179 of file ElggComment.php.

getThreadGUID()

ElggComment::getThreadGUID

(

)

Return the thread GUID this comment is a part of.

Returns

int

Since

4.1

Definition at line 165 of file ElggComment.php.

initializeAttributes()

ElggComment::initializeAttributes ( )

protected

Set subtype to comment.

Returns

void

Reimplemented from ElggObject.

Definition at line 18 of file ElggComment.php.

isCreatedByContentOwner()

ElggComment::isCreatedByContentOwner

(

)

Is this comment created by the same owner as the content of the item being commented on.

Returns

bool

Since

4.1

Definition at line 138 of file ElggComment.php.

persistentDelete()

ElggComment::persistentDelete ( bool  $recursive = true )

protected

{Permanently delete the entity from the database.

Parameters

bool

$recursive

If true (default) then all entities which are owned or contained by $this will also be deleted.

Returns

bool

Since

6.0

}

Reimplemented from ElggEntity.

Definition at line 29 of file ElggComment.php.

restore()

ElggComment::restore

(

bool

$recursive = true

)

{Restore the entity.

Parameters

bool

$recursive

Recursively restores all entities trashed with the entity?

Returns

bool

Since

6.0

}

Reimplemented from ElggEntity.

Definition at line 55 of file ElggComment.php.

trash()

ElggComment::trash ( bool  $recursive = true )

protected

{Move the entity to the trash.

Parameters

bool

$recursive

If true (default) then all entities which are owned or contained by $this will also be trashed.

Returns

bool

Since

6.0

}

Reimplemented from ElggEntity.

Definition at line 42 of file ElggComment.php.

---

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

• engine/classes/ElggComment.php