Inheritance diagram for ElggEntity:

Public Member Functions
	__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...

	getDisplayName ()
	Get the entity's display name. More...

	setDisplayName (string $display_name)
	Sets the title or name of this entity. 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...

	canComment (int $user_guid=0)
	Can a user comment on an entity? 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 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 ()

	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...

	restore (bool $recursive=true)
	Restore 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 ()
	{} 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...

	getURL ()
	Get a URL for this object. More...

	save ()
	Save this data to the appropriate database table. More...

	delete ()
	Delete this data. More...

	getTimeCreated ()
	Returns the UNIX epoch time that this entity was created. More...

	toObject (array $params=[])
	Get a plain old object copy for public consumption. More...

	getSystemLogID ()
	Return an identification for the object for storage in the system log. More...

	getType ()
	Return the type of the object - eg. More...

	getSubtype ()
	Return a subtype. More...

	getObjectFromID (int $id)
	For a given ID, return the object associated with it. 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...

Static Public Member Functions
static	getDefaultFields ()
	Returns a default set of fields to be used for forms related to this entity. More...

Public Attributes
const	PRIMARY_ATTR_NAMES

Protected Member Functions
	initializeAttributes ()
	Initialize the attributes array. More...

	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...

	persistentDelete (bool $recursive=true)
	Permanently delete the entity from the database. More...

	trash (bool $recursive=true)
	Move the entity to the trash. More...

	prepareObject (\Elgg\Export\Entity $object)
	Prepare an object copy for toObject() More...

Protected Member Functions inherited from ElggData
	initializeAttributes ()
	Initialize the attributes array. More...

	getDatabase ()
	Provides a pointer to the database object. More...

Protected Attributes
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 52 of file ElggEntity.php.

Constructor & Destructor Documentation

ElggEntity::__construct ( ?\stdClass $row = null )

Create a new entity.

Plugin developers should only use the constructor to create a new entity. To retrieve entities, use get_entity() and the elgg_get_entities* functions.

If no arguments are passed, it creates a new entity. If a database result is passed as a instance, it instantiates that entity.

Parameters

null | \stdClass $row Database row result. Default is null to create a new object.

Exceptions

IOException If cannot load remaining data from db

Definition at line 122 of file ElggEntity.php.

Member Function Documentation

ElggEntity::__clone ( )

Clone an entity.

Resets the guid so that the entity can be saved as a distinct entity from the original. Creation time will be set when this new entity is saved. The owner and container guids come from the original entity. The clone method copies metadata but does not copy annotations.

Returns: void

Definition at line 165 of file ElggEntity.php.

ElggEntity::__get ( $name )

Get an attribute or metadata value.

If the name matches an attribute, the attribute is returned. If metadata does not exist with that name, a null is returned.

This only returns an array if there are multiple values for a particular $name key.

Parameters

string $name Name of the attribute or metadata

Returns: mixed

Definition at line 293 of file ElggEntity.php.

ElggEntity::__set	(	$name,
		$value
	)

Set an attribute or metadata value for this entity.

Anything that is not an attribute is saved as metadata.

Be advised that metadata values are cast to integer or string. You can save booleans, but they will be stored and returned as integers.

Parameters

string	$name	Name of the attribute or metadata
mixed	$value	The value to be set

Returns: void

Exceptions

Definition at line 218 of file ElggEntity.php.

ElggEntity::cache ( )

Cache the entity in a session cache.

Returns: void

Definition at line 1315 of file ElggEntity.php.

ElggEntity::canAnnotate	(	int	$user_guid = `0`,
		string	$annotation_name = `''`
	)

Can a user annotate an entity?

Can be overridden by registering for the event [permissions_check:annotate:<name>, <entity type>="">] or [permissions_check:annotate, <entity type>="">]. The events are called in that order.

If you want logged out users to annotate an object, do not call canAnnotate(). It's easier than using the event.

Parameters

int	$user_guid	User guid (default is logged in user)
string	$annotation_name	The name of the annotation (default is unspecified)

Returns: bool

Definition at line 460 of file ElggEntity.php.

ElggEntity::canComment ( int $user_guid = 0 )

Can a user comment on an entity?

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

Definition at line 442 of file ElggEntity.php.

ElggEntity::canDelete ( int $user_guid = 0 )

Can a user delete this entity?

Can be overridden by registering for the permissions_check:delete event.

Parameters

int $user_guid The user GUID, optionally (default: logged in user)

Returns: bool Whether this entity is deletable by the given user.

Since: 1.11

Definition at line 411 of file ElggEntity.php.

ElggEntity::canEdit ( int $user_guid = 0 )

Can a user edit this entity?

Can be overridden by registering for the permissions_check event.

Parameters

int $user_guid The user GUID, optionally (default: logged in user)

Returns: bool Whether this entity is editable by the given user.

Definition at line 397 of file ElggEntity.php.

ElggEntity::canWriteToContainer	(	int	$user_guid = `0`,
		string	$type = `''`,
		string	$subtype = `''`
	)

Can a user add an entity to this container.

Parameters

int	$user_guid	The GUID of the user creating the entity (0 for logged in user).
string	$type	The type of entity we're looking to write
string	$subtype	The subtype of the entity we're looking to write

Returns: bool

Exceptions

Definition at line 425 of file ElggEntity.php.

ElggEntity::countComments ( )

Count the number of comments attached to this entity.

Returns: int Number of comments

Since: 1.8.0

Definition at line 361 of file ElggEntity.php.

ElggEntity::create ( )

protected

Create a new entry in the entities table.

Saves the base information in the entities table for the entity. Saving the type-specific information is handled in the calling class method.

Returns: int|false The new entity's GUID or false if prevented by an event handler

Exceptions

Definition at line 614 of file ElggEntity.php.

ElggEntity::delete	(	bool	$recursive = `true`,
		?bool	$persistent = `null`
	)

Deletes the entity.

Removes the entity and its metadata, annotations, relationships, river entries, and private data.

Optionally can remove entities contained and owned by this entity.

Warning: If deleting recursively, this bypasses ownership of items contained by the entity. That means that if the container_guid = $this->guid, the item will be deleted regardless of who owns it.

Parameters

bool	$recursive	If true (default) then all entities which are owned or contained by $this will also be deleted.
bool \| null	$persistent	persistently delete the entity (default: check the 'restorable' capability)

Returns: bool

Definition at line 1021 of file ElggEntity.php.

ElggEntity::disable	(	string	$reason = `''`,
		bool	$recursive = `true`
	)

Disable this entity.

Disabled entities are not returned by getter functions. To enable an entity, use ElggEntity::enable().Recursivelydisablinganentitywilldisableallentitiesownedorcontainedbytheparententity.@noteInternal:Disablinganentitysetsthe'enabled'columnto'no'.@paramstring$reasonOptionalreason@parambool$recursiveRecursivelydisableallcontainedentities?@returnbool@see\ElggEntity::enable()

Definition at line 868 of file ElggEntity.php.

ElggEntity::disableCaching ( )

Disable runtime caching for entity.

Returns: void

Definition at line 1274 of file ElggEntity.php.

ElggEntity::enable ( bool $recursive = true )

Enable the entity.

Parameters

bool $recursive Recursively enable all entities disabled with the entity?

Returns: bool

Definition at line 950 of file ElggEntity.php.

ElggEntity::enableCaching ( )

Enable runtime caching for entity.

Returns: void

Definition at line 1287 of file ElggEntity.php.

ElggEntity::getContainerEntity ( )

Get the container entity for this object.

Returns: |null

Since: 1.8.0

Definition at line 552 of file ElggEntity.php.

ElggEntity::getContainerGUID ( )

Gets the container GUID for this entity.

Returns: int

Definition at line 542 of file ElggEntity.php.

static ElggEntity::getDefaultFields ( )

static

Returns a default set of fields to be used for forms related to this entity.

Returns: array

Definition at line 1355 of file ElggEntity.php.

ElggEntity::getDisplayName ( )

Get the entity's display name.

Returns: string The title or name of this entity.

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

Definition at line 306 of file ElggEntity.php.

ElggEntity::getFields ( )

final

Helper function to easily retrieve form fields for this entity.

Returns: array

Definition at line 1364 of file ElggEntity.php.

ElggEntity::getGUID ( )

Returns the guid.

Returns: int|null GUID

Definition at line 469 of file ElggEntity.php.

ElggEntity::getLatitude ( )

Return the entity's latitude.

Returns: float

Definition at line 1195 of file ElggEntity.php.

ElggEntity::getLongitude ( )

Return the entity's longitude.

Returns: float

Definition at line 1204 of file ElggEntity.php.

ElggEntity::getObjectFromID ( int $id )

For a given ID, return the object associated with it.

This is used by the system log. It can be called on any Loggable object.

Parameters

int $id GUID

Returns: |null

Definition at line 1227 of file ElggEntity.php.

ElggEntity::getOriginalAttributes ( )

Get the original values of attribute(s) that have been modified since the entity was persisted.

Returns: array

Definition at line 276 of file ElggEntity.php.

ElggEntity::getOwnerEntity ( )

Gets the that owns this entity.

Returns: |null

Definition at line 522 of file ElggEntity.php.

ElggEntity::getOwnerGUID ( )

Get the guid of the entity's owner.

Returns: int The owner GUID

Definition at line 513 of file ElggEntity.php.

ElggEntity::getSubtype ( )

Get the entity subtype.

Returns: string The entity subtype

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

Definition at line 504 of file ElggEntity.php.

ElggEntity::getSystemLogID ( )

{}

Definition at line 1215 of file ElggEntity.php.

ElggEntity::getTimeUpdated ( )

Returns the UNIX epoch time that this entity was last updated.

Returns: int UNIX epoch time

Definition at line 561 of file ElggEntity.php.

ElggEntity::getType ( )

Returns the entity type.

Returns: string The entity type

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

Definition at line 478 of file ElggEntity.php.

ElggEntity::getURL ( )

Gets the URL for this entity.

Plugins can register for the 'entity:url', '<type>' event to customize the url for an entity.

Returns: string The URL of the entity

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

Definition at line 573 of file ElggEntity.php.

ElggEntity::getVolatileData ( string $name )

Get a piece of volatile (non-persisted) data on this entity.

Parameters

string $name The name of the volatile data

Returns: mixed The value or null if not found.

Definition at line 328 of file ElggEntity.php.

ElggEntity::hasAccess ( int $user_guid = 0 )

Check if the given user has access to this entity.

Parameters

int $user_guid the GUID of the user to check access for (default: logged in user_guid)

Returns: bool

Since: 4.3

Definition at line 384 of file ElggEntity.php.

ElggEntity::hasCapability ( string $capability )

Checks a specific capability is enabled for the entity type/subtype.

Parameters

string $capability capability to check

Returns: bool

Since: 4.1

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

Definition at line 1346 of file ElggEntity.php.

ElggEntity::initializeAttributes ( )

protected

Initialize the attributes array.

This is vital to distinguish between metadata and base parameters.

Returns: void

Definition at line 137 of file ElggEntity.php.

ElggEntity::invalidateCache ( )

Invalidate cache for entity.

Returns: void

Definition at line 1329 of file ElggEntity.php.

ElggEntity::isCacheable ( )

Is entity cacheable in the runtime cache.

Returns: bool

Definition at line 1297 of file ElggEntity.php.

ElggEntity::isDeleted ( )

Is the entity marked as deleted.

Returns: bool

Definition at line 1138 of file ElggEntity.php.

ElggEntity::isEnabled ( )

Is this entity enabled?

Returns: boolean Whether this entity is enabled.

Definition at line 1000 of file ElggEntity.php.

ElggEntity::load ( stdClass $row )

protected

Loads attributes from the entities table into the object.

Parameters

stdClass $row Object of properties from database row(s)

Returns: bool

Definition at line 824 of file ElggEntity.php.

ElggEntity::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

Definition at line 1054 of file ElggEntity.php.

ElggEntity::prepareObject ( \Elgg\Export\Entity $object )

protected

Prepare an object copy for toObject()

Parameters

\Elgg\Export\Entity $object Object representation of the entity

Returns

Definition at line 1164 of file ElggEntity.php.

ElggEntity::removeAllRelatedRiverItems ( )

Removes all river items related to this entity.

Returns: void

Definition at line 349 of file ElggEntity.php.

ElggEntity::restore ( bool $recursive = true )

Restore the entity.

Parameters

bool $recursive Recursively restores all entities trashed with the entity?

Returns: bool

Since: 6.0

Definition at line 1083 of file ElggEntity.php.

ElggEntity::save ( )

Definition at line 588 of file ElggEntity.php.

ElggEntity::setContainerGUID ( int $container_guid )

Set the container for this object.

Parameters

int $container_guid The ID of the container.

Returns: void

Definition at line 533 of file ElggEntity.php.

ElggEntity::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

Definition at line 317 of file ElggEntity.php.

ElggEntity::setLatLong	(	float	$lat,
		float	$long
	)

Set latitude and longitude metadata tags for a given entity.

Parameters

float	$lat	Latitude
float	$long	Longitude

Returns: void

Definition at line 1185 of file ElggEntity.php.

ElggEntity::setSubtype ( string $subtype )

Set the subtype of the entity.

Parameters

string $subtype the new type

Returns: void

See also: self::initializeAttributes()

Definition at line 490 of file ElggEntity.php.

ElggEntity::setVolatileData	(	string	$name,
			$value
	)

Set a piece of volatile (non-persisted) data on this entity.

Parameters

string	$name	Name
mixed	$value	Value

Returns: void

Definition at line 340 of file ElggEntity.php.

ElggEntity::toObject ( array $params = [] )

Export an entity.

Parameters

array $params Params to pass to the event

Returns

Definition at line 1149 of file ElggEntity.php.

ElggEntity::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

Definition at line 1066 of file ElggEntity.php.

ElggEntity::update ( )

protected

Update the entity in the database.

Returns: bool Whether the update was successful.

Exceptions

Definition at line 759 of file ElggEntity.php.

ElggEntity::updateLastAction ( ?int $posted = null )

Update the last_action column in the entities table.

Warning: This is different to time_updated. Time_updated is automatically set, while last_action is only set when explicitly called.

Parameters

null | int $posted Timestamp of last action

Returns: int

Definition at line 1242 of file ElggEntity.php.

ElggEntity::updateTimeDeleted ( ?int $deleted = null )

Update the time_deleted column in the entities table.

Parameters

null | int $deleted Timestamp of deletion

Returns: int

Definition at line 1259 of file ElggEntity.php.

Member Data Documentation

ElggEntity::$_is_cacheable = true

protected

Definition at line 106 of file ElggEntity.php.

ElggEntity::$orig_attributes = []

protected

Definition at line 101 of file ElggEntity.php.

ElggEntity::$volatile = []

protected

Definition at line 95 of file ElggEntity.php.

const ElggEntity::INTEGER_ATTR_NAMES

protected

Initial value:

= [
        'guid',
        'owner_guid',
        'container_guid',
        'access_id',
        'time_created',
        'time_updated',
        'last_action',
        'time_deleted',
    ]

Definition at line 79 of file ElggEntity.php.

const ElggEntity::PRIMARY_ATTR_NAMES

Initial value:

= [
        'guid',
        'type',
        'subtype',
        'owner_guid',
        'container_guid',
        'access_id',
        'time_created',
        'time_updated',
        'last_action',
        'enabled',
        'deleted',
        'time_deleted',
    ]

Definition at line 61 of file ElggEntity.php.

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

engine/classes/ElggEntity.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation