class ShortcutSetStorage
Same name in other branches
- 9 core/modules/shortcut/src/ShortcutSetStorage.php \Drupal\shortcut\ShortcutSetStorage
- 10 core/modules/shortcut/src/ShortcutSetStorage.php \Drupal\shortcut\ShortcutSetStorage
- 11.x core/modules/shortcut/src/ShortcutSetStorage.php \Drupal\shortcut\ShortcutSetStorage
Defines a storage for shortcut_set entities.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\EntityStorageBase extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityStorageInterface, \Drupal\Core\Entity\EntityHandlerInterface
- class \Drupal\Core\Config\Entity\ConfigEntityStorage extends \Drupal\Core\Entity\EntityStorageBase implements \Drupal\Core\Config\Entity\ConfigEntityStorageInterface, \Drupal\Core\Config\Entity\ImportableEntityStorageInterface
- class \Drupal\shortcut\ShortcutSetStorage extends \Drupal\Core\Config\Entity\ConfigEntityStorage implements \Drupal\shortcut\ShortcutSetStorageInterface
- class \Drupal\Core\Config\Entity\ConfigEntityStorage extends \Drupal\Core\Entity\EntityStorageBase implements \Drupal\Core\Config\Entity\ConfigEntityStorageInterface, \Drupal\Core\Config\Entity\ImportableEntityStorageInterface
- class \Drupal\Core\Entity\EntityStorageBase extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityStorageInterface, \Drupal\Core\Entity\EntityHandlerInterface
Expanded class hierarchy of ShortcutSetStorage
File
-
core/
modules/ shortcut/ src/ ShortcutSetStorage.php, line 20
Namespace
Drupal\shortcutView source
class ShortcutSetStorage extends ConfigEntityStorage implements ShortcutSetStorageInterface {
/**
* The module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
/**
* Constructs a ShortcutSetStorageController object.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_info
* The entity info for the entity type.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory service.
* @param \Drupal\Component\Uuid\UuidInterface $uuid_service
* The UUID service.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\Cache\MemoryCache\MemoryCacheInterface $memory_cache
* The memory cache.
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
*/
public function __construct(EntityTypeInterface $entity_info, ConfigFactoryInterface $config_factory, UuidInterface $uuid_service, ModuleHandlerInterface $module_handler, LanguageManagerInterface $language_manager, MemoryCacheInterface $memory_cache, Connection $connection) {
parent::__construct($entity_info, $config_factory, $uuid_service, $language_manager, $memory_cache);
$this->moduleHandler = $module_handler;
$this->connection = $connection;
}
/**
* {@inheritdoc}
*/
public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_info) {
return new static($entity_info, $container->get('config.factory'), $container->get('uuid'), $container->get('module_handler'), $container->get('language_manager'), $container->get('entity.memory_cache'), $container->get('database'));
}
/**
* {@inheritdoc}
*/
public function deleteAssignedShortcutSets(ShortcutSetInterface $entity) {
// First, delete any user assignments for this set, so that each of these
// users will go back to using whatever default set applies.
$this->connection
->delete('shortcut_set_users')
->condition('set_name', $entity->id())
->execute();
}
/**
* {@inheritdoc}
*/
public function assignUser(ShortcutSetInterface $shortcut_set, $account) {
$this->connection
->merge('shortcut_set_users')
->key('uid', $account->id())
->fields([
'set_name' => $shortcut_set->id(),
])
->execute();
drupal_static_reset('shortcut_current_displayed_set');
}
/**
* {@inheritdoc}
*/
public function unassignUser($account) {
$deleted = $this->connection
->delete('shortcut_set_users')
->condition('uid', $account->id())
->execute();
return (bool) $deleted;
}
/**
* {@inheritdoc}
*/
public function getAssignedToUser($account) {
$query = $this->connection
->select('shortcut_set_users', 'ssu');
$query->fields('ssu', [
'set_name',
]);
$query->condition('ssu.uid', $account->id());
return $query->execute()
->fetchField();
}
/**
* {@inheritdoc}
*/
public function countAssignedUsers(ShortcutSetInterface $shortcut_set) {
return Database::getConnection()->query('SELECT COUNT(*) FROM {shortcut_set_users} WHERE set_name = :name', [
':name' => $shortcut_set->id(),
])
->fetchField();
}
/**
* {@inheritdoc}
*/
public function getDefaultSet(AccountInterface $account) {
// Allow modules to return a default shortcut set name. Since we can only
// have one, we allow the last module which returns a valid result to take
// precedence. If no module returns a valid set, fall back on the site-wide
// default, which is the lowest-numbered shortcut set.
$suggestions = array_reverse($this->moduleHandler
->invokeAll('shortcut_default_set', [
$account,
]));
$suggestions[] = 'default';
$shortcut_set = NULL;
foreach ($suggestions as $name) {
if ($shortcut_set = $this->load($name)) {
break;
}
}
return $shortcut_set;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigEntityStorage::$configFactory | protected | property | The config factory service. | ||
ConfigEntityStorage::$configStorage | protected | property | The config storage service. | ||
ConfigEntityStorage::$entities | protected | property | Static cache of entities, keyed first by entity ID, then by an extra key. | ||
ConfigEntityStorage::$languageManager | protected | property | The language manager. | ||
ConfigEntityStorage::$overrideFree | protected | property | Determines if the underlying configuration is retrieved override free. | ||
ConfigEntityStorage::$uuidKey | protected | property | Name of entity's UUID database table field, if it supports UUIDs. | Overrides EntityStorageBase::$uuidKey | |
ConfigEntityStorage::buildCacheId | protected | function | Builds the cache ID for the passed in entity ID. | Overrides EntityStorageBase::buildCacheId | |
ConfigEntityStorage::createFromStorageRecord | public | function | Creates a configuration entity from storage values. | Overrides ConfigEntityStorageInterface::createFromStorageRecord | |
ConfigEntityStorage::deleteRevision | public | function | Delete a specific entity revision. | Overrides EntityStorageInterface::deleteRevision | |
ConfigEntityStorage::doCreate | protected | function | Performs storage-specific creation of entities. | Overrides EntityStorageBase::doCreate | |
ConfigEntityStorage::doDelete | protected | function | Performs storage-specific entity deletion. | Overrides EntityStorageBase::doDelete | |
ConfigEntityStorage::doLoadMultiple | protected | function | Performs storage-specific loading of entities. | Overrides EntityStorageBase::doLoadMultiple | |
ConfigEntityStorage::doSave | protected | function | Performs storage-specific saving of the entity. | Overrides EntityStorageBase::doSave | |
ConfigEntityStorage::getIDFromConfigName | public static | function | Extracts the configuration entity ID from the full configuration name. | Overrides ConfigEntityStorageInterface::getIDFromConfigName | |
ConfigEntityStorage::getPrefix | protected | function | Returns the prefix used to create the configuration name. | ||
ConfigEntityStorage::getQueryServiceName | protected | function | Gets the name of the service for the query for this entity storage. | Overrides EntityStorageBase::getQueryServiceName | |
ConfigEntityStorage::has | protected | function | Determines if this entity already exists in storage. | Overrides EntityStorageBase::has | |
ConfigEntityStorage::hasData | public | function | Determines if the storage contains any data. | Overrides EntityStorageBase::hasData | |
ConfigEntityStorage::importCreate | public | function | Creates entities upon synchronizing configuration changes. | Overrides ImportableEntityStorageInterface::importCreate | 1 |
ConfigEntityStorage::importDelete | public | function | Delete entities upon synchronizing configuration changes. | Overrides ImportableEntityStorageInterface::importDelete | 2 |
ConfigEntityStorage::importRename | public | function | Renames entities upon synchronizing configuration changes. | Overrides ImportableEntityStorageInterface::importRename | |
ConfigEntityStorage::importUpdate | public | function | Updates entities upon synchronizing configuration changes. | Overrides ImportableEntityStorageInterface::importUpdate | 1 |
ConfigEntityStorage::invokeHook | protected | function | Invokes a hook on behalf of the entity. | Overrides EntityStorageBase::invokeHook | |
ConfigEntityStorage::loadMultipleOverrideFree | public | function | Loads one or more entities in their original form without overrides. | Overrides ConfigEntityStorageInterface::loadMultipleOverrideFree | |
ConfigEntityStorage::loadOverrideFree | public | function | Loads one entity in their original form without overrides. | Overrides ConfigEntityStorageInterface::loadOverrideFree | |
ConfigEntityStorage::loadRevision | public | function | Load a specific entity revision. | Overrides EntityStorageInterface::loadRevision | |
ConfigEntityStorage::mapToStorageRecord | protected | function | Maps from an entity object to the storage record. | 3 | |
ConfigEntityStorage::MAX_ID_LENGTH | constant | Length limit of the configuration entity ID. | 1 | ||
ConfigEntityStorage::save | public | function | Implements Drupal\Core\Entity\EntityStorageInterface::save(). | Overrides EntityStorageBase::save | |
ConfigEntityStorage::updateFromStorageRecord | public | function | Updates a configuration entity from storage values. | Overrides ConfigEntityStorageInterface::updateFromStorageRecord | |
ConfigEntityStorage::_doCreateFromStorageRecord | protected | function | Helps create a configuration entity from storage values. | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
EntityHandlerBase::moduleHandler | protected | function | Gets the module handler. | 2 | |
EntityHandlerBase::setModuleHandler | public | function | Sets the module handler for this handler. | ||
EntityStorageBase::$entityClass | protected | property | Name of the entity class. | ||
EntityStorageBase::$entityType | protected | property | Information about the entity type. | ||
EntityStorageBase::$entityTypeId | protected | property | Entity type ID for this storage. | ||
EntityStorageBase::$idKey | protected | property | Name of the entity's ID field in the entity database table. | ||
EntityStorageBase::$langcodeKey | protected | property | The name of the entity langcode property. | 1 | |
EntityStorageBase::$memoryCache | protected | property | The memory cache. | ||
EntityStorageBase::$memoryCacheTag | protected | property | The memory cache cache tag. | ||
EntityStorageBase::$uuidService | protected | property | The UUID service. | 1 | |
EntityStorageBase::buildPropertyQuery | protected | function | Builds an entity query. | 1 | |
EntityStorageBase::create | public | function | Constructs a new entity object, without permanently saving it. | Overrides EntityStorageInterface::create | 1 |
EntityStorageBase::delete | public | function | Deletes permanently saved entities. | Overrides EntityStorageInterface::delete | 2 |
EntityStorageBase::doPostSave | protected | function | Performs post save entity processing. | 1 | |
EntityStorageBase::doPreSave | protected | function | Performs presave entity processing. | 1 | |
EntityStorageBase::getAggregateQuery | public | function | Gets an aggregated query instance. | Overrides EntityStorageInterface::getAggregateQuery | |
EntityStorageBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityStorageInterface::getEntityType | |
EntityStorageBase::getEntityTypeId | public | function | Gets the entity type ID. | Overrides EntityStorageInterface::getEntityTypeId | |
EntityStorageBase::getFromStaticCache | protected | function | Gets entities from the static cache. | ||
EntityStorageBase::getQuery | public | function | Gets an entity query instance. | Overrides EntityStorageInterface::getQuery | |
EntityStorageBase::load | public | function | Loads one entity. | Overrides EntityStorageInterface::load | 2 |
EntityStorageBase::loadByProperties | public | function | Load entities by their property values. | Overrides EntityStorageInterface::loadByProperties | 3 |
EntityStorageBase::loadMultiple | public | function | Loads one or more entities. | Overrides EntityStorageInterface::loadMultiple | 1 |
EntityStorageBase::loadUnchanged | public | function | Loads an unchanged entity from the database. | Overrides EntityStorageInterface::loadUnchanged | 1 |
EntityStorageBase::mapFromStorageRecords | protected | function | Maps from storage records to entity objects. | 4 | |
EntityStorageBase::postLoad | protected | function | Attaches data to entities upon loading. | ||
EntityStorageBase::preLoad | protected | function | Gathers entities from a 'preload' step. | 1 | |
EntityStorageBase::resetCache | public | function | Resets the internal, static entity cache. | Overrides EntityStorageInterface::resetCache | 2 |
EntityStorageBase::restore | public | function | Restores a previously saved entity. | Overrides EntityStorageInterface::restore | 1 |
EntityStorageBase::setStaticCache | protected | function | Stores entities in the static entity cache. | ||
EntityStorageInterface::FIELD_LOAD_CURRENT | constant | Load the most recent version of an entity's field data. | |||
EntityStorageInterface::FIELD_LOAD_REVISION | constant | Load the version of an entity's field data specified in the entity. | |||
ShortcutSetStorage::$connection | protected | property | The database connection. | ||
ShortcutSetStorage::$moduleHandler | protected | property | The module handler. | Overrides EntityHandlerBase::$moduleHandler | |
ShortcutSetStorage::assignUser | public | function | Assigns a user to a particular shortcut set. | Overrides ShortcutSetStorageInterface::assignUser | |
ShortcutSetStorage::countAssignedUsers | public | function | Get the number of users who have this set assigned to them. | Overrides ShortcutSetStorageInterface::countAssignedUsers | |
ShortcutSetStorage::createInstance | public static | function | Instantiates a new instance of this entity handler. | Overrides ConfigEntityStorage::createInstance | |
ShortcutSetStorage::deleteAssignedShortcutSets | public | function | Delete shortcut sets assigned to users. | Overrides ShortcutSetStorageInterface::deleteAssignedShortcutSets | |
ShortcutSetStorage::getAssignedToUser | public | function | Get the name of the set assigned to this user. | Overrides ShortcutSetStorageInterface::getAssignedToUser | |
ShortcutSetStorage::getDefaultSet | public | function | Gets the default shortcut set for a given user account. | Overrides ShortcutSetStorageInterface::getDefaultSet | |
ShortcutSetStorage::unassignUser | public | function | Unassigns a user from any shortcut set they may have been assigned to. | Overrides ShortcutSetStorageInterface::unassignUser | |
ShortcutSetStorage::__construct | public | function | Constructs a ShortcutSetStorageController object. | Overrides ConfigEntityStorage::__construct | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.