interface ConfigEntityStorageInterface in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/Config/Entity/ConfigEntityStorageInterface.php \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
Provides an interface for configuration entity storage.
Hierarchy
- interface \Drupal\Core\Entity\EntityStorageInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
Expanded class hierarchy of ConfigEntityStorageInterface
All classes that implement ConfigEntityStorageInterface
5 files declare their use of ConfigEntityStorageInterface
- DateFormatFormBase.php in core/
modules/ system/ src/ Form/ DateFormatFormBase.php - Contains \Drupal\system\Form\DateFormatFormBase.
- EntityFieldManagerTest.php in core/
tests/ Drupal/ Tests/ Core/ Entity/ EntityFieldManagerTest.php - Contains \Drupal\Tests\Core\Entity\EntityFieldManagerTest.
- RoleStorageInterface.php in core/
modules/ user/ src/ RoleStorageInterface.php - Contains \Drupal\user\RoleStorageInterface.
- ShortcutSetStorageInterface.php in core/
modules/ shortcut/ src/ ShortcutSetStorageInterface.php - Contains \Drupal\shortcut\ShortcutSetStorageInterface.
- VocabularyStorageInterface.php in core/
modules/ taxonomy/ src/ VocabularyStorageInterface.php - Contains \Drupal\taxonomy\VocabularyStorageInterface.
File
- core/
lib/ Drupal/ Core/ Config/ Entity/ ConfigEntityStorageInterface.php, line 15 - Contains \Drupal\Core\Config\Entity\ConfigEntityStorageInterface.
Namespace
Drupal\Core\Config\EntityView source
interface ConfigEntityStorageInterface extends EntityStorageInterface {
/**
* Extracts the configuration entity ID from the full configuration name.
*
* @param string $config_name
* The full configuration name to extract the ID from. E.g.
* 'views.view.archive'.
* @param string $config_prefix
* The config prefix of the configuration entity. E.g. 'views.view'
*
* @return string
* The ID of the configuration entity.
*/
public static function getIDFromConfigName($config_name, $config_prefix);
/**
* Creates a configuration entity from storage values.
*
* Allows the configuration entity storage to massage storage values before
* creating an entity.
*
* @param array $values
* The array of values from the configuration storage.
*
* @return ConfigEntityInterface
* The configuration entity.
*
* @see \Drupal\Core\Entity\EntityStorageBase::mapFromStorageRecords()
* @see \Drupal\field\FieldStorageConfigStorage::mapFromStorageRecords()
*/
public function createFromStorageRecord(array $values);
/**
* Updates a configuration entity from storage values.
*
* Allows the configuration entity storage to massage storage values before
* updating an entity.
*
* @param ConfigEntityInterface $entity
* The configuration entity to update.
* @param array $values
* The array of values from the configuration storage.
*
* @return ConfigEntityInterface
* The configuration entity.
*
* @see \Drupal\Core\Entity\EntityStorageBase::mapFromStorageRecords()
* @see \Drupal\field\FieldStorageConfigStorage::mapFromStorageRecords()
*/
public function updateFromStorageRecord(ConfigEntityInterface $entity, array $values);
/**
* Loads one entity in their original form without overrides.
*
* @param mixed $id
* The ID of the entity to load.
*
* @return \Drupal\Core\Entity\EntityInterface|null
* An entity object. NULL if no matching entity is found.
*/
public function loadOverrideFree($id);
/**
* Loads one or more entities in their original form without overrides.
*
* @param $ids
* An array of entity IDs, or NULL to load all entities.
*
* @return \Drupal\Core\Entity\EntityInterface[]
* An array of entity objects indexed by their IDs. Returns an empty array
* if no matching entities are found.
*/
public function loadMultipleOverrideFree(array $ids = NULL);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigEntityStorageInterface:: |
public | function | Creates a configuration entity from storage values. | 1 |
ConfigEntityStorageInterface:: |
public static | function | Extracts the configuration entity ID from the full configuration name. | 1 |
ConfigEntityStorageInterface:: |
public | function | Loads one or more entities in their original form without overrides. | 1 |
ConfigEntityStorageInterface:: |
public | function | Loads one entity in their original form without overrides. | 1 |
ConfigEntityStorageInterface:: |
public | function | Updates a configuration entity from storage values. | 1 |
EntityStorageInterface:: |
public | function | Constructs a new entity object, without permanently saving it. | 1 |
EntityStorageInterface:: |
public | function | Deletes permanently saved entities. | 1 |
EntityStorageInterface:: |
public | function | Delete a specific entity revision. | 3 |
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. | ||
EntityStorageInterface:: |
public | function | Gets an aggregated query instance. | 1 |
EntityStorageInterface:: |
public | function | Gets the entity type definition. | 1 |
EntityStorageInterface:: |
public | function | Gets the entity type ID. | 1 |
EntityStorageInterface:: |
public | function | Gets an entity query instance. | 1 |
EntityStorageInterface:: |
public | function | Loads one entity. | 1 |
EntityStorageInterface:: |
public | function | Load entities by their property values. | 1 |
EntityStorageInterface:: |
public | function | Loads one or more entities. | 1 |
EntityStorageInterface:: |
public | function | Load a specific entity revision. | 3 |
EntityStorageInterface:: |
public | function | Loads an unchanged entity from the database. | 1 |
EntityStorageInterface:: |
public | function | Resets the internal, static entity cache. | 1 |
EntityStorageInterface:: |
public | function | Saves the entity permanently. | 1 |