Entity table database service. More...

Public Member Functions
	__construct (Config $config, Database $db, EntityCache $entity_cache, MetadataCache $metadata_cache, EventsService $events, SessionManagerService $session_manager, Translator $translator)
	Constructor. More...

	setEntityClass (string $type, string $subtype, string $class= '')
	Sets class constructor name for entities with given type and subtype. More...

	getEntityClass (string $type, string $subtype)
	Returns class name registered as a constructor for a given type and subtype. More...

	getRow (int $guid, int $user_guid=null)
	Returns a database row from the entities table. More...

	insertRow (\stdClass $row, array $attributes=[])
	Adds a new row to the entity table. More...

	updateRow (int $guid,\stdClass $row)
	Update entity table row. More...

	rowToElggStar (\stdClass $row)
	Create an Elgg* object from a given entity row. More...

	getFromCache (int $guid)
	Get an entity from the in-memory or memcache caches. More...

	invalidateCache (int $guid)
	Invalidate cache for entity. More...

	get (int $guid, string $type=null, string $subtype=null)
	Loads and returns an entity object from a guid. More...

	exists (int $guid)
	Does an entity exist? More...

	fetch (QueryBuilder $query, array $options=[])
	Returns an array of entities with optional filtering. More...

	updateLastAction (\ElggEntity $entity, int $posted=null)
	Update the last_action column in the entities table for $entity. More...

	getUserForPermissionsCheck (int $guid=null)
	Get a user by GUID even if the entity is hidden or disabled. More...

	enable (\ElggEntity $entity)
	Enables entity. More...

	disable (\ElggEntity $entity)
	Disables entity. More...

	delete (\ElggEntity $entity, bool $recursive=true)
	Delete entity and all of its properties. More...

Public Attributes
const	TABLE_NAME = 'entities'

Protected Member Functions
	deleteRelatedEntities (\ElggEntity $entity)
	Deletes entities owned or contained by the entity being deletes. More...

	deleteEntityProperties (\ElggEntity $entity)
	Clear data from secondary tables. More...

Protected Attributes
Config	$config

Database	$db

EntityCache	$entity_cache

EntityPreloader	$entity_preloader

MetadataCache	$metadata_cache

EventsService	$events

SessionManagerService	$session_manager

Translator	$translator

array	$deleted_guids = []

array	$entity_classes = []

Detailed Description

Entity table database service.

Definition at line 26 of file EntityTable.php.

Constructor & Destructor Documentation

Elgg\Database\EntityTable::__construct	(	Config	$config,
		Database	$db,
		EntityCache	$entity_cache,
		MetadataCache	$metadata_cache,
		EventsService	$events,
		SessionManagerService	$session_manager,
		Translator	$translator
	)

Constructor.

Parameters

Config	$config	Config
Database	$db	Database
EntityCache	$entity_cache	Entity cache
MetadataCache	$metadata_cache	Metadata cache
EventsService	$events	Events service
SessionManagerService	$session_manager	Session manager
Translator	$translator	Translator

Definition at line 67 of file EntityTable.php.

Member Function Documentation

Elgg\Database\EntityTable::delete	(	\ElggEntity	$entity,
		bool	$recursive = `true`
	)

Delete entity and all of its properties.

Parameters

\ElggEntity	$entity	Entity
bool	$recursive	Delete all owned and contained entities

Returns: bool

Definition at line 481 of file EntityTable.php.

Elgg\Database\EntityTable::deleteEntityProperties ( \ElggEntity $entity )

protected

Clear data from secondary tables.

Parameters

\ElggEntity $entity Entity

Returns: void

Definition at line 567 of file EntityTable.php.

Elgg\Database\EntityTable::deleteRelatedEntities ( \ElggEntity $entity )

protected

Deletes entities owned or contained by the entity being deletes.

Parameters

\ElggEntity $entity Entity

Returns: void

Definition at line 524 of file EntityTable.php.

Elgg\Database\EntityTable::disable ( \ElggEntity $entity )

Disables entity.

Parameters

\ElggEntity $entity Entity to disable

Returns: bool

Definition at line 465 of file EntityTable.php.

Elgg\Database\EntityTable::enable ( \ElggEntity $entity )

Enables entity.

Parameters

\ElggEntity $entity Entity to enable

Returns: bool

Definition at line 450 of file EntityTable.php.

Elgg\Database\EntityTable::exists ( int $guid )

Does an entity exist?

This function checks for the existence of an entity independent of access permissions. It is useful for situations when a user cannot access an entity and it must be determined whether entity has been deleted or the access level has changed.

Parameters

int $guid The GUID of the entity

Returns: bool

Definition at line 340 of file EntityTable.php.

Elgg\Database\EntityTable::fetch	(	QueryBuilder	$query,
		array	$options = `[]`
	)

Returns an array of entities with optional filtering.

Entities are the basic unit of storage in Elgg. This function provides the simplest way to get an array of entities. There are many options available that can be passed to filter what sorts of entities are returned.

Parameters

QueryBuilder	$query	Query
array	$options	Options

Returns: []

Definition at line 360 of file EntityTable.php.

Elgg\Database\EntityTable::get	(	int	$guid,
		string	$type = `null`,
		string	$subtype = `null`
	)

Loads and returns an entity object from a guid.

Parameters

int	$guid	The GUID of the entity
string	$type	The type of the entity If given, even an existing entity with the given GUID will not be returned unless its type matches
string	$subtype	The subtype of the entity If given, even an existing entity with the given GUID will not be returned unless its subtype matches

Returns: |null The correct Elgg or custom object based upon entity type and subtype

Definition at line 294 of file EntityTable.php.

Elgg\Database\EntityTable::getEntityClass	(	string	$type,
		string	$subtype
	)

Returns class name registered as a constructor for a given type and subtype.

Parameters

string	$type	Entity type
string	$subtype	Entity subtype

Returns: string

Definition at line 111 of file EntityTable.php.

Elgg\Database\EntityTable::getFromCache ( int $guid )

Get an entity from the in-memory or memcache caches.

Parameters

int $guid GUID

Returns: |null

Definition at line 244 of file EntityTable.php.

Elgg\Database\EntityTable::getRow	(	int	$guid,
		int	$user_guid = `null`
	)

Returns a database row from the entities table.

Use get_entity() to return the fully loaded entity.

Warning: This will only return results if a) it exists, b) you have access to it.

Parameters

int	$guid	The GUID of the object to extract
int	$user_guid	GUID of the user accessing the row Defaults to logged in user if null Builds an access query for a logged out user if 0

Returns: |null

Definition at line 129 of file EntityTable.php.

Elgg\Database\EntityTable::getUserForPermissionsCheck ( int $guid = null )

Get a user by GUID even if the entity is hidden or disabled.

Parameters

int $guid User GUID. Default is logged in user

Returns: |null

Exceptions

UserFetchFailureException

Definition at line 422 of file EntityTable.php.

Elgg\Database\EntityTable::insertRow	(	\stdClass	$row,
		array	$attributes = `[]`
	)

Adds a new row to the entity table.

Parameters

\stdClass	$row	Entity base information
array	$attributes	All primary table attributes Used by database mock services to allow mocking entities that were instantiated using new keyword and calling ElggEntity::save()

Returns: int

Definition at line 156 of file EntityTable.php.

Elgg\Database\EntityTable::invalidateCache ( int $guid )

Invalidate cache for entity.

Parameters

int $guid GUID

Returns: void

Definition at line 272 of file EntityTable.php.

Elgg\Database\EntityTable::rowToElggStar ( \stdClass $row )

Create an Elgg* object from a given entity row.

Handles loading all tables into the correct class.

Parameters

\stdClass $row The row of the entry in the entities table.

Returns: |null

Exceptions

ClassException
DomainException

Definition at line 203 of file EntityTable.php.

Elgg\Database\EntityTable::setEntityClass	(	string	$type,
		string	$subtype,
		string	$class = `''`
	)

Sets class constructor name for entities with given type and subtype.

Parameters

string	$type	Entity type
string	$subtype	Entity subtype
string	$class	Entity class

Returns: void

Exceptions

DomainException

Definition at line 95 of file EntityTable.php.

Elgg\Database\EntityTable::updateLastAction	(	\ElggEntity	$entity,
		int	$posted = `null`
	)

Update the last_action column in the entities table for $entity.

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

Parameters

\ElggEntity	$entity	Entity annotation\|relationship action carried out on
int	$posted	Timestamp of last action

Returns: int

Definition at line 400 of file EntityTable.php.

Elgg\Database\EntityTable::updateRow	(	int	$guid,
		\stdClass	$row
	)

Update entity table row.

Parameters

int	$guid	Entity guid
\stdClass	$row	Updated data

Returns: bool

Definition at line 180 of file EntityTable.php.

Member Data Documentation

Config Elgg\Database\EntityTable::$config

protected

Definition at line 36 of file EntityTable.php.

Database Elgg\Database\EntityTable::$db

protected

Definition at line 38 of file EntityTable.php.

array Elgg\Database\EntityTable::$deleted_guids = []

protected

Definition at line 52 of file EntityTable.php.

EntityCache Elgg\Database\EntityTable::$entity_cache

protected

Definition at line 40 of file EntityTable.php.

array Elgg\Database\EntityTable::$entity_classes = []

protected

Definition at line 54 of file EntityTable.php.

EntityPreloader Elgg\Database\EntityTable::$entity_preloader

protected

Definition at line 42 of file EntityTable.php.

EventsService Elgg\Database\EntityTable::$events

protected

Definition at line 46 of file EntityTable.php.

MetadataCache Elgg\Database\EntityTable::$metadata_cache

protected

Definition at line 44 of file EntityTable.php.

SessionManagerService Elgg\Database\EntityTable::$session_manager

protected

Definition at line 48 of file EntityTable.php.

Translator Elgg\Database\EntityTable::$translator

protected

Definition at line 50 of file EntityTable.php.

const Elgg\Database\EntityTable::TABLE_NAME = 'entities'

Definition at line 34 of file EntityTable.php.

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

engine/classes/Elgg/Database/EntityTable.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation