Elgg  Version master
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Elgg\Database\EntityTable Class Reference

Entity table database service. More...

Public Member Functions

 __construct (Config $config, Database $db, EntityCache $entity_cache, MetadataCache $metadata_cache, EventsService $events,\ElggSession $session, 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 ($guid)
 Get an entity from the in-memory or memcache caches. More...
 
 invalidateCache ($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 $guid. More...
 
 getUserForPermissionsCheck ($guid=0)
 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, $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
 
 $db
 
 $entity_classes
 
 $entity_cache
 
 $entity_preloader
 
 $metadata_cache
 
 $events
 
 $session
 
 $translator
 
 $deleted_guids = []
 

Detailed Description

Entity table database service.

Definition at line 25 of file EntityTable.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters
Config$configConfig
Database$dbDatabase
EntityCache$entity_cacheEntity cache
MetadataCache$metadata_cacheMetadata cache
EventsService$eventsEvents service
\ElggSession$sessionSession
Translator$translatorTranslator

Definition at line 96 of file EntityTable.php.

Member Function Documentation

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

Delete entity and all of its properties.

Parameters
\ElggEntity$entityEntity
bool$recursiveDelete all owned and contained entities
Returns
bool

Definition at line 519 of file EntityTable.php.

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

Clear data from secondary tables.

Parameters
\ElggEntity$entityEntity
Returns
void

Definition at line 604 of file EntityTable.php.

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

Deletes entities owned or contained by the entity being deletes.

Parameters
\ElggEntity$entityEntity
Returns
void

Definition at line 562 of file EntityTable.php.

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

Disables entity.

Parameters
\ElggEntity$entityEntity to disable
Returns
bool

Definition at line 503 of file EntityTable.php.

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

Enables entity.

Parameters
\ElggEntity$entityEntity to enable
Returns
bool

Definition at line 488 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$guidThe GUID of the entity
Returns
bool

Definition at line 374 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$queryQuery
array$optionsOptions
Returns
[]

Definition at line 397 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$guidThe GUID of the entity
string$typeThe type of the entity If given, even an existing entity with the given GUID will not be returned unless its type matches
string$subtypeThe 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 327 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$typeEntity type
string$subtypeEntity subtype
Returns
string

Definition at line 140 of file EntityTable.php.

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

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

Parameters
int$guidGUID
Returns
|false

Definition at line 278 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$guidThe GUID of the object to extract
int$user_guidGUID 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 162 of file EntityTable.php.

Elgg\Database\EntityTable::getUserForPermissionsCheck (   $guid = 0)

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

Parameters
int$guidUser GUID. Default is logged in user
Returns
|null
Exceptions
UserFetchFailureException

Definition at line 460 of file EntityTable.php.

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

Adds a new row to the entity table.

Parameters
\stdClass$rowEntity base information
array$attributesAll primary table attributes Used by database mock services to allow mocking entities that were instantiated using new keyword and calling ElggEntity::save()
Returns
int|false

Definition at line 190 of file EntityTable.php.

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

Invalidate cache for entity.

Parameters
int$guidGUID
Returns
void

Definition at line 305 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$rowThe row of the entry in the entities table.
Returns
|null
Exceptions
ClassException
InvalidParameterException

Definition at line 237 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$typeEntity type
string$subtypeEntity subtype
string$classEntity class
Returns
void
Exceptions
InvalidParameterException

Definition at line 124 of file EntityTable.php.

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

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

Warning
This is different to time_updated. Time_updated is automatically set, while last_action is only set when explicitly called.
Parameters
\ElggEntity$entityEntity annotation|relationship action carried out on
int$postedTimestamp of last action
Returns
int

Definition at line 437 of file EntityTable.php.

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

Update entity table row.

Parameters
int$guidEntity guid
\stdClass$rowUpdated data
Returns
bool

Definition at line 214 of file EntityTable.php.

Member Data Documentation

Elgg\Database\EntityTable::$config
protected

Definition at line 38 of file EntityTable.php.

Elgg\Database\EntityTable::$db
protected

Definition at line 43 of file EntityTable.php.

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

Definition at line 83 of file EntityTable.php.

Elgg\Database\EntityTable::$entity_cache
protected

Definition at line 53 of file EntityTable.php.

Elgg\Database\EntityTable::$entity_classes
protected

Definition at line 48 of file EntityTable.php.

Elgg\Database\EntityTable::$entity_preloader
protected

Definition at line 58 of file EntityTable.php.

Elgg\Database\EntityTable::$events
protected

Definition at line 68 of file EntityTable.php.

Elgg\Database\EntityTable::$metadata_cache
protected

Definition at line 63 of file EntityTable.php.

Elgg\Database\EntityTable::$session
protected

Definition at line 73 of file EntityTable.php.

Elgg\Database\EntityTable::$translator
protected

Definition at line 78 of file EntityTable.php.

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

Definition at line 33 of file EntityTable.php.


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