class FlaggingStorage in Flag 8.4
Default SQL flagging storage.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityStorageBase implements EntityHandlerInterface, EntityStorageInterface
- class \Drupal\Core\Entity\ContentEntityStorageBase implements ContentEntityStorageInterface, DynamicallyFieldableEntityStorageInterface uses DeprecatedServicePropertyTrait
- class \Drupal\Core\Entity\Sql\SqlContentEntityStorage implements EntityBundleListenerInterface, DynamicallyFieldableEntityStorageSchemaInterface, SqlEntityStorageInterface
- class \Drupal\flag\Entity\Storage\FlaggingStorage implements FlaggingStorageInterface
- class \Drupal\Core\Entity\Sql\SqlContentEntityStorage implements EntityBundleListenerInterface, DynamicallyFieldableEntityStorageSchemaInterface, SqlEntityStorageInterface
- class \Drupal\Core\Entity\ContentEntityStorageBase implements ContentEntityStorageInterface, DynamicallyFieldableEntityStorageInterface uses DeprecatedServicePropertyTrait
- class \Drupal\Core\Entity\EntityStorageBase implements EntityHandlerInterface, EntityStorageInterface
Expanded class hierarchy of FlaggingStorage
File
- src/
Entity/ Storage/ FlaggingStorage.php, line 12
Namespace
Drupal\flag\Entity\StorageView source
class FlaggingStorage extends SqlContentEntityStorage implements FlaggingStorageInterface {
/**
* Stores loaded flags per user, entity type and IDs.
*
* @var array
*/
protected $flagIdsByEntity = [];
/**
* Stores global flags per entity type and IDs.
* @var array
*/
protected $globalFlagIdsByEntity = [];
/**
* {@inheritdoc}
*/
public function resetCache(array $ids = NULL) {
parent::resetCache($ids);
$this->flagIdsByEntity = [];
$this->globalFlagIdsByEntity = [];
}
/**
* {@inheritdoc}
*/
public function loadIsFlagged(EntityInterface $entity, AccountInterface $account, $session_id = NULL) {
if ($account
->isAnonymous() && is_null($session_id)) {
throw new \LogicException('Anonymous users must be identified by session_id');
}
$flag_ids = $this
->loadIsFlaggedMultiple([
$entity,
], $account, $session_id);
return $flag_ids[$entity
->id()];
}
/**
* {@inheritdoc}
*/
public function loadIsFlaggedMultiple(array $entities, AccountInterface $account, $session_id = NULL) {
if ($account
->isAnonymous() && is_null($session_id)) {
throw new \LogicException('Anonymous users must be identified by session_id');
}
// Set a dummy value for $session_id for an authenticated user so that we
// can use it as a key in the cache array.
if (!$account
->isAnonymous()) {
$session_id = 0;
}
$flag_ids_by_entity = [];
if (!$entities) {
return $flag_ids_by_entity;
}
// All entities must be of the same type, get the entity type from the
// first.
$entity_type_id = reset($entities)
->getEntityTypeId();
$ids_to_load = [];
// Loop over all requested entities, if they are already in the loaded list,
// get then from there, merge the global and per-user flags together.
foreach ($entities as $entity) {
if (isset($this->flagIdsByEntity[$account
->id()][$session_id][$entity_type_id][$entity
->id()])) {
$flag_ids_by_entity[$entity
->id()] = array_merge($this->flagIdsByEntity[$account
->id()][$session_id][$entity_type_id][$entity
->id()], $this->globalFlagIdsByEntity[$entity_type_id][$entity
->id()]);
}
else {
$ids_to_load[$entity
->id()] = [];
}
}
// If there are no entities that need to be loaded, return the list.
if (!$ids_to_load) {
return $flag_ids_by_entity;
}
// Initialize the loaded lists with the missing ID's as an empty array.
if (!isset($this->flagIdsByEntity[$account
->id()][$session_id][$entity_type_id])) {
$this->flagIdsByEntity[$account
->id()][$session_id][$entity_type_id] = [];
}
if (!isset($this->globalFlagIdsByEntity[$entity_type_id])) {
$this->globalFlagIdsByEntity[$entity_type_id] = [];
}
$this->flagIdsByEntity[$account
->id()][$session_id][$entity_type_id] += $ids_to_load;
$this->globalFlagIdsByEntity[$entity_type_id] += $ids_to_load;
$flag_ids_by_entity += $ids_to_load;
// Directly query the table to avoid he overhead of loading the content
// entities.
$query = $this->database
->select('flagging', 'f')
->fields('f', [
'entity_id',
'flag_id',
'global',
])
->condition('entity_type', $entity_type_id)
->condition('entity_id', array_keys($ids_to_load), 'IN');
// The flagging must either match the user or be global.
$user_or_global_condition = $query
->orConditionGroup()
->condition('global', 1);
if ($account
->isAnonymous()) {
$uid_and_session_condition = $query
->andConditionGroup()
->condition('uid', $account
->id())
->condition('session_id', $session_id);
$user_or_global_condition
->condition($uid_and_session_condition);
}
else {
$user_or_global_condition
->condition('uid', $account
->id());
}
$result = $query
->condition($user_or_global_condition)
->execute();
// Loop over all results, put them in the cached list and the list that will
// be returned.
foreach ($result as $row) {
if ($row->global) {
$this->globalFlagIdsByEntity[$entity_type_id][$row->entity_id][$row->flag_id] = $row->flag_id;
}
else {
$this->flagIdsByEntity[$account
->id()][$session_id][$entity_type_id][$row->entity_id][$row->flag_id] = $row->flag_id;
}
$flag_ids_by_entity[$row->entity_id][$row->flag_id] = $row->flag_id;
}
return $flag_ids_by_entity;
}
/**
* {@inheritdoc}
*/
protected function doPostSave(EntityInterface $entity, $update) {
parent::doPostSave($entity, $update);
// After updating or creating a flagging, add it to the cached flagging by entity if already in static cache.
if ($entity
->get('global')->value) {
// If the global flags by entity for this entity have already been cached, then add the newly created flagging.
if (isset($this->globalFlagIdsByEntity[$entity
->get('entity_type')->value][$entity
->get('entity_id')->value])) {
$this->globalFlagIdsByEntity[$entity
->get('entity_type')->value][$entity
->get('entity_id')->value][$entity
->get('flag_id')->value] = $entity
->get('flag_id')->value;
}
}
else {
// If the flags by entity for this entity/user have already been cached, then add the newly created flagging.
if (isset($this->flagIdsByEntity[$entity
->get('uid')->target_id][$entity
->get('entity_type')->value][$entity
->get('entity_id')->value])) {
$this->flagIdsByEntity[$entity
->get('uid')->target_id][$entity
->get('entity_type')->value][$entity
->get('entity_id')->value][$entity
->get('flag_id')->value] = $entity
->get('flag_id')->value;
}
}
}
/**
* {@inheritdoc}
*/
protected function doDelete($entities) {
parent::doDelete($entities);
/** @var \Drupal\Core\Entity\ContentEntityInterface[] $entities */
foreach ($entities as $entity) {
// After deleting a flagging, remove it from the cached flagging by entity if already in static cache.
if ($entity
->get('global')->value) {
if (isset($this->globalFlagIdsByEntity[$entity
->get('entity_type')->value][$entity
->get('entity_id')->value][$entity
->get('flag_id')->value])) {
unset($this->globalFlagIdsByEntity[$entity
->get('entity_type')->value][$entity
->get('entity_id')->value][$entity
->get('flag_id')->value]);
}
}
else {
if (isset($this->flagIdsByEntity[$entity
->get('uid')->target_id][$entity
->get('entity_type')->value][$entity
->get('entity_id')->value][$entity
->get('flag_id')->value])) {
unset($this->flagIdsByEntity[$entity
->get('uid')->target_id][$entity
->get('entity_type')->value][$entity
->get('entity_id')->value][$entity
->get('flag_id')->value]);
}
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContentEntityStorageBase:: |
protected | property | The entity bundle key. | |
ContentEntityStorageBase:: |
protected | property | Cache backend. | |
ContentEntityStorageBase:: |
protected | property | ||
ContentEntityStorageBase:: |
protected | property | The entity field manager service. | |
ContentEntityStorageBase:: |
protected | property | The entity bundle info. | |
ContentEntityStorageBase:: |
protected | property | Stores the latest revision IDs for entities. | |
ContentEntityStorageBase:: |
protected | function | Ensures integer entity key values are valid. | |
ContentEntityStorageBase:: |
public | function |
Creates a new revision starting off from the specified entity object. Overrides TranslatableRevisionableStorageInterface:: |
|
ContentEntityStorageBase:: |
public | function |
Constructs a new entity translation object, without permanently saving it. Overrides TranslatableStorageInterface:: |
|
ContentEntityStorageBase:: |
public | function |
Creates an entity with sample field values. Overrides ContentEntityStorageInterface:: |
1 |
ContentEntityStorageBase:: |
public | function |
Delete a specific entity revision. Overrides EntityStorageInterface:: |
1 |
ContentEntityStorageBase:: |
protected | function |
Performs storage-specific creation of entities. Overrides EntityStorageBase:: |
|
ContentEntityStorageBase:: |
protected | function |
Performs presave entity processing. Overrides EntityStorageBase:: |
|
ContentEntityStorageBase:: |
protected | function |
Performs storage-specific saving of the entity. Overrides EntityStorageBase:: |
1 |
ContentEntityStorageBase:: |
protected | function | Gets entities from the persistent cache backend. | |
ContentEntityStorageBase:: |
public | function |
Returns the latest revision identifier for an entity. Overrides RevisionableStorageInterface:: |
|
ContentEntityStorageBase:: |
public | function |
Returns the latest revision affecting the specified translation. Overrides TranslatableRevisionableStorageInterface:: |
|
ContentEntityStorageBase:: |
protected | function | Returns an array of field names to skip when merging revision translations. | |
ContentEntityStorageBase:: |
protected | function | Checks whether the field values changed compared to the original entity. | |
ContentEntityStorageBase:: |
protected | function | Initializes field values. | |
ContentEntityStorageBase:: |
protected | function | Invokes a method on the Field objects within an entity. | |
ContentEntityStorageBase:: |
protected | function | Invokes the post save method on the Field objects within an entity. | |
ContentEntityStorageBase:: |
protected | function |
Invokes a hook on behalf of the entity. Overrides EntityStorageBase:: |
1 |
ContentEntityStorageBase:: |
protected | function | Invokes hook_entity_storage_load(). | |
ContentEntityStorageBase:: |
protected | function | Checks translation statuses and invoke the related hooks if needed. | |
ContentEntityStorageBase:: |
protected | function | Checks whether any entity revision is translated. | |
ContentEntityStorageBase:: |
protected | function | Checks whether any stored entity revision is translated. | |
ContentEntityStorageBase:: |
public | function |
Loads multiple entity revisions. Overrides RevisionableStorageInterface:: |
1 |
ContentEntityStorageBase:: |
public | function |
Load a specific entity revision. Overrides EntityStorageInterface:: |
1 |
ContentEntityStorageBase:: |
public | function |
Loads an unchanged entity from the database. Overrides EntityStorageBase:: |
|
ContentEntityStorageBase:: |
public | function |
Reacts to the creation of a field. Overrides FieldDefinitionListenerInterface:: |
|
ContentEntityStorageBase:: |
public | function |
Reacts to the update of a field. Overrides FieldDefinitionListenerInterface:: |
|
ContentEntityStorageBase:: |
protected | function | Populates the affected flag for all the revision translations. | |
ContentEntityStorageBase:: |
protected | function |
Gathers entities from a 'preload' step. Overrides EntityStorageBase:: |
|
ContentEntityStorageBase:: |
public | function |
Purges a batch of field data. Overrides FieldableEntityStorageInterface:: |
|
ContentEntityStorageBase:: |
protected | function | Stores entities in the persistent cache backend. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
EntityHandlerBase:: |
protected | property | The module handler to invoke hooks on. | 2 |
EntityHandlerBase:: |
protected | function | Gets the module handler. | 2 |
EntityHandlerBase:: |
public | function | Sets the module handler for this handler. | |
EntityStorageBase:: |
protected | property | Name of the entity class. | |
EntityStorageBase:: |
protected | property | Information about the entity type. | |
EntityStorageBase:: |
protected | property | Entity type ID for this storage. | |
EntityStorageBase:: |
protected | property | Name of the entity's ID field in the entity database table. | |
EntityStorageBase:: |
protected | property | The memory cache. | |
EntityStorageBase:: |
protected | property | The memory cache cache tag. | |
EntityStorageBase:: |
protected | property | Name of entity's UUID database table field, if it supports UUIDs. | 1 |
EntityStorageBase:: |
protected | property | The UUID service. | 1 |
EntityStorageBase:: |
protected | function | Builds the cache ID for the passed in entity ID. | 1 |
EntityStorageBase:: |
public | function |
Constructs a new entity object, without permanently saving it. Overrides EntityStorageInterface:: |
1 |
EntityStorageBase:: |
public | function |
Gets an aggregated query instance. Overrides EntityStorageInterface:: |
|
EntityStorageBase:: |
public | function |
Gets the entity type definition. Overrides EntityStorageInterface:: |
|
EntityStorageBase:: |
public | function |
Gets the entity type ID. Overrides EntityStorageInterface:: |
|
EntityStorageBase:: |
protected | function | Gets entities from the static cache. | |
EntityStorageBase:: |
public | function |
Gets an entity query instance. Overrides EntityStorageInterface:: |
|
EntityStorageBase:: |
public | function |
Determines if the storage contains any data. Overrides EntityStorageInterface:: |
3 |
EntityStorageBase:: |
public | function |
Loads one entity. Overrides EntityStorageInterface:: |
2 |
EntityStorageBase:: |
public | function |
Load entities by their property values. Overrides EntityStorageInterface:: |
3 |
EntityStorageBase:: |
public | function |
Loads one or more entities. Overrides EntityStorageInterface:: |
1 |
EntityStorageBase:: |
protected | function | Attaches data to entities upon loading. | |
EntityStorageBase:: |
protected | function | Stores entities in the static entity cache. | |
EntityStorageInterface:: |
constant | Load the most recent version of an entity's field data. | ||
EntityStorageInterface:: |
constant | Load the version of an entity's field data specified in the entity. | ||
FlaggingStorage:: |
protected | property | Stores loaded flags per user, entity type and IDs. | |
FlaggingStorage:: |
protected | property | Stores global flags per entity type and IDs. | |
FlaggingStorage:: |
protected | function |
Performs storage-specific entity deletion. Overrides ContentEntityStorageBase:: |
|
FlaggingStorage:: |
protected | function |
Performs post save entity processing. Overrides ContentEntityStorageBase:: |
|
FlaggingStorage:: |
public | function |
Loads a list of flags the entity is flagged with for the given account. Overrides FlaggingStorageInterface:: |
|
FlaggingStorage:: |
public | function |
Loads a list of flags the entities are flagged with for the given account. Overrides FlaggingStorageInterface:: |
|
FlaggingStorage:: |
public | function |
Resets the internal, static entity cache. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | property | The base table of the entity. | |
SqlContentEntityStorage:: |
protected | property | Active database connection. | |
SqlContentEntityStorage:: |
protected | property | The table that stores properties, if the entity has multilingual support. | |
SqlContentEntityStorage:: |
protected | property | The default language entity key. | |
SqlContentEntityStorage:: |
protected | property | The entity type manager. | |
SqlContentEntityStorage:: |
protected | property | The entity type's field storage definitions. | |
SqlContentEntityStorage:: |
protected | property |
The entity langcode key. Overrides EntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | property | The language manager. | |
SqlContentEntityStorage:: |
protected | property | The table that stores revision field data if the entity supports revisions. | |
SqlContentEntityStorage:: |
protected | property | Name of entity's revision database table field, if it supports revisions. | |
SqlContentEntityStorage:: |
protected | property | The table that stores revisions, if the entity supports revisions. | |
SqlContentEntityStorage:: |
protected | property | The entity type's storage schema object. | |
SqlContentEntityStorage:: |
protected | property | The mapping of field columns to SQL tables. | |
SqlContentEntityStorage:: |
protected | property | Whether this storage should use the temporary table mapping. | |
SqlContentEntityStorage:: |
protected | function |
Builds an entity query. Overrides EntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function | Builds the query to load the entity. | |
SqlContentEntityStorage:: |
public | function |
Determines the number of entities with values for a given field. Overrides FieldableEntityStorageInterface:: |
|
SqlContentEntityStorage:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides ContentEntityStorageBase:: |
1 |
SqlContentEntityStorage:: |
public | function |
Deletes permanently saved entities. Overrides EntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function | Deletes values of fields in dedicated tables for all revisions. | |
SqlContentEntityStorage:: |
protected | function | Deletes values of fields in dedicated tables for all revisions. | |
SqlContentEntityStorage:: |
protected | function |
Deletes entity field values from the storage. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function |
Deletes field values of an entity revision from the storage. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function |
Performs storage-specific loading of entities. Overrides EntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function |
Actually loads revision field item values from the storage. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function |
Actually loads revision field item values from the storage. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function |
Writes entity field values to the storage. Overrides ContentEntityStorageBase:: |
1 |
SqlContentEntityStorage:: |
public | function |
Performs final cleanup after all data of a field has been purged. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
public | function | Gets the base table name. | |
SqlContentEntityStorage:: |
public | function | Gets a table mapping for the specified entity type and storage definitions. | |
SqlContentEntityStorage:: |
public | function | Gets the data table name. | |
SqlContentEntityStorage:: |
public | function | Gets the base field definitions for a content entity type. | |
SqlContentEntityStorage:: |
protected | function | Gets entities from the storage. | |
SqlContentEntityStorage:: |
protected | function |
Gets the name of the service for the query for this entity storage. Overrides EntityStorageBase:: |
|
SqlContentEntityStorage:: |
public | function | Gets the revision data table name. | |
SqlContentEntityStorage:: |
public | function | Gets the revision table name. | |
SqlContentEntityStorage:: |
protected | function | Gets the entity type's storage schema object. | |
SqlContentEntityStorage:: |
public | function |
Gets a table mapping for the entity's SQL tables. Overrides SqlEntityStorageInterface:: |
|
SqlContentEntityStorage:: |
protected | function |
Determines if this entity already exists in storage. Overrides EntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function | Initializes table name variables. | |
SqlContentEntityStorage:: |
protected | function | Checks whether a field column should be treated as serial. | 1 |
SqlContentEntityStorage:: |
protected | function | Loads values of fields stored in dedicated tables for a group of entities. | |
SqlContentEntityStorage:: |
protected | function | Loads values for fields stored in the shared data tables. | |
SqlContentEntityStorage:: |
protected | function |
Maps from storage records to entity objects, and attaches fields. Overrides EntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function | Maps from an entity object to the storage record of the field data. | |
SqlContentEntityStorage:: |
protected | function | Maps from an entity object to the storage record. | |
SqlContentEntityStorage:: |
public | function |
Reacts to a bundle being created. Overrides EntityBundleListenerInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to a bundle being deleted. Overrides EntityBundleListenerInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the creation of the entity type. Overrides EntityTypeListenerInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the deletion of the entity type. Overrides EntityTypeListenerInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the update of the entity type. Overrides EntityTypeListenerInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the creation of the fieldable entity type. Overrides EntityTypeListenerInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the update of a fieldable entity type. Overrides EntityTypeListenerInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the deletion of a field. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the creation of a field storage definition. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the deletion of a field storage definition. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
public | function |
Reacts to the update of a field storage definition. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function |
Removes field items from storage per entity during purge. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
protected | function |
Reads values to be purged for a single field. Overrides ContentEntityStorageBase:: |
|
SqlContentEntityStorage:: |
public | function |
Checks if existing data would be lost if the schema changes were applied. Overrides EntityStorageSchemaInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Checks if the changes to the entity type requires storage schema changes. Overrides EntityStorageSchemaInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Checks if existing data would be lost if the schema changes were applied. Overrides DynamicallyFieldableEntityStorageSchemaInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Checks if the changes to the storage definition requires schema changes. Overrides DynamicallyFieldableEntityStorageSchemaInterface:: |
|
SqlContentEntityStorage:: |
public | function |
Restores a previously saved entity. Overrides EntityStorageBase:: |
|
SqlContentEntityStorage:: |
public | function |
Saves the entity permanently. Overrides EntityStorageBase:: |
1 |
SqlContentEntityStorage:: |
protected | function | Saves an entity revision. | |
SqlContentEntityStorage:: |
protected | function | Saves values of fields that use dedicated tables. | 1 |
SqlContentEntityStorage:: |
protected | function | Saves fields that use the shared tables. | |
SqlContentEntityStorage:: |
public | function | Updates the wrapped entity type definition. | |
SqlContentEntityStorage:: |
public | function | Updates the internal list of field storage definitions. | |
SqlContentEntityStorage:: |
public | function | Sets the wrapped table mapping definition. | |
SqlContentEntityStorage:: |
public | function | Changes the temporary state of the storage. | |
SqlContentEntityStorage:: |
protected | function | Determines whether the passed field has been already deleted. | |
SqlContentEntityStorage:: |
protected | function | Wraps a database schema exception into an entity storage exception. | |
SqlContentEntityStorage:: |
public | function |
Constructs a SqlContentEntityStorage object. Overrides ContentEntityStorageBase:: |
1 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |