123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642 |
- <?php
- namespace Drupal\Core\Config\Entity;
- use Drupal\Component\Utility\NestedArray;
- use Drupal\Core\Cache\Cache;
- use Drupal\Core\Config\Schema\SchemaIncompleteException;
- use Drupal\Core\Entity\Entity;
- use Drupal\Core\Config\ConfigDuplicateUUIDException;
- use Drupal\Core\Entity\EntityStorageInterface;
- use Drupal\Core\Entity\EntityTypeInterface;
- use Drupal\Core\Entity\EntityWithPluginCollectionInterface;
- use Drupal\Core\Plugin\PluginDependencyTrait;
- /**
- * Defines a base configuration entity class.
- *
- * @ingroup entity_api
- */
- abstract class ConfigEntityBase extends Entity implements ConfigEntityInterface {
- use PluginDependencyTrait {
- addDependency as addDependencyTrait;
- }
- /**
- * The original ID of the configuration entity.
- *
- * The ID of a configuration entity is a unique string (machine name). When a
- * configuration entity is updated and its machine name is renamed, the
- * original ID needs to be known.
- *
- * @var string
- */
- protected $originalId;
- /**
- * The enabled/disabled status of the configuration entity.
- *
- * @var bool
- */
- protected $status = TRUE;
- /**
- * The UUID for this entity.
- *
- * @var string
- */
- protected $uuid;
- /**
- * Whether the config is being created, updated or deleted through the
- * import process.
- *
- * @var bool
- */
- private $isSyncing = FALSE;
- /**
- * Whether the config is being deleted by the uninstall process.
- *
- * @var bool
- */
- private $isUninstalling = FALSE;
- /**
- * The language code of the entity's default language.
- *
- * Assumed to be English by default. ConfigEntityStorage will set an
- * appropriate language when creating new entities. This default applies to
- * imported default configuration where the language code is missing. Those
- * should be assumed to be English. All configuration entities support third
- * party settings, so even configuration entities that do not directly
- * store settings involving text in a human language may have such third
- * party settings attached. This means configuration entities should be in one
- * of the configured languages or the built-in English.
- *
- * @var string
- */
- protected $langcode = 'en';
- /**
- * Third party entity settings.
- *
- * An array of key/value pairs keyed by provider.
- *
- * @var array
- */
- protected $third_party_settings = [];
- /**
- * Information maintained by Drupal core about configuration.
- *
- * Keys:
- * - default_config_hash: A hash calculated by the config.installer service
- * and added during installation.
- *
- * @var array
- */
- protected $_core = [];
- /**
- * Trust supplied data and not use configuration schema on save.
- *
- * @var bool
- */
- protected $trustedData = FALSE;
- /**
- * {@inheritdoc}
- */
- public function __construct(array $values, $entity_type) {
- parent::__construct($values, $entity_type);
- // Backup the original ID, if any.
- // Configuration entity IDs are strings, and '0' is a valid ID.
- $original_id = $this->id();
- if ($original_id !== NULL && $original_id !== '') {
- $this->setOriginalId($original_id);
- }
- }
- /**
- * {@inheritdoc}
- */
- public function getOriginalId() {
- return $this->originalId;
- }
- /**
- * {@inheritdoc}
- */
- public function setOriginalId($id) {
- // Do not call the parent method since that would mark this entity as no
- // longer new. Unlike content entities, new configuration entities have an
- // ID.
- // @todo https://www.drupal.org/node/2478811 Document the entity life cycle
- // and the differences between config and content.
- $this->originalId = $id;
- return $this;
- }
- /**
- * Overrides Entity::isNew().
- *
- * EntityInterface::enforceIsNew() is only supported for newly created
- * configuration entities but has no effect after saving, since each
- * configuration entity is unique.
- */
- public function isNew() {
- return !empty($this->enforceIsNew);
- }
- /**
- * {@inheritdoc}
- */
- public function get($property_name) {
- return isset($this->{$property_name}) ? $this->{$property_name} : NULL;
- }
- /**
- * {@inheritdoc}
- */
- public function set($property_name, $value) {
- if ($this instanceof EntityWithPluginCollectionInterface) {
- $plugin_collections = $this->getPluginCollections();
- if (isset($plugin_collections[$property_name])) {
- // If external code updates the settings, pass it along to the plugin.
- $plugin_collections[$property_name]->setConfiguration($value);
- }
- }
- $this->{$property_name} = $value;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function enable() {
- return $this->setStatus(TRUE);
- }
- /**
- * {@inheritdoc}
- */
- public function disable() {
- return $this->setStatus(FALSE);
- }
- /**
- * {@inheritdoc}
- */
- public function setStatus($status) {
- $this->status = (bool) $status;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function status() {
- return !empty($this->status);
- }
- /**
- * {@inheritdoc}
- */
- public function setSyncing($syncing) {
- $this->isSyncing = $syncing;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function isSyncing() {
- return $this->isSyncing;
- }
- /**
- * {@inheritdoc}
- */
- public function setUninstalling($uninstalling) {
- $this->isUninstalling = $uninstalling;
- }
- /**
- * {@inheritdoc}
- */
- public function isUninstalling() {
- return $this->isUninstalling;
- }
- /**
- * {@inheritdoc}
- */
- public function createDuplicate() {
- $duplicate = parent::createDuplicate();
- // Prevent the new duplicate from being misinterpreted as a rename.
- $duplicate->setOriginalId(NULL);
- return $duplicate;
- }
- /**
- * Helper callback for uasort() to sort configuration entities by weight and label.
- */
- public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
- $a_weight = isset($a->weight) ? $a->weight : 0;
- $b_weight = isset($b->weight) ? $b->weight : 0;
- if ($a_weight == $b_weight) {
- $a_label = $a->label();
- $b_label = $b->label();
- return strnatcasecmp($a_label, $b_label);
- }
- return ($a_weight < $b_weight) ? -1 : 1;
- }
- /**
- * {@inheritdoc}
- */
- public function toArray() {
- $properties = [];
- /** @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $entity_type */
- $entity_type = $this->getEntityType();
- $properties_to_export = $entity_type->getPropertiesToExport();
- if (empty($properties_to_export)) {
- $config_name = $entity_type->getConfigPrefix() . '.' . $this->id();
- $definition = $this->getTypedConfig()->getDefinition($config_name);
- if (!isset($definition['mapping'])) {
- throw new SchemaIncompleteException("Incomplete or missing schema for $config_name");
- }
- $properties_to_export = array_combine(array_keys($definition['mapping']), array_keys($definition['mapping']));
- }
- $id_key = $entity_type->getKey('id');
- foreach ($properties_to_export as $property_name => $export_name) {
- // Special handling for IDs so that computed compound IDs work.
- // @see \Drupal\Core\Entity\EntityDisplayBase::id()
- if ($property_name == $id_key) {
- $properties[$export_name] = $this->id();
- }
- else {
- $properties[$export_name] = $this->get($property_name);
- }
- }
- if (empty($this->third_party_settings)) {
- unset($properties['third_party_settings']);
- }
- if (empty($this->_core)) {
- unset($properties['_core']);
- }
- return $properties;
- }
- /**
- * Gets the typed config manager.
- *
- * @return \Drupal\Core\Config\TypedConfigManagerInterface
- */
- protected function getTypedConfig() {
- return \Drupal::service('config.typed');
- }
- /**
- * {@inheritdoc}
- */
- public function preSave(EntityStorageInterface $storage) {
- parent::preSave($storage);
- if ($this instanceof EntityWithPluginCollectionInterface) {
- // Any changes to the plugin configuration must be saved to the entity's
- // copy as well.
- foreach ($this->getPluginCollections() as $plugin_config_key => $plugin_collection) {
- $this->set($plugin_config_key, $plugin_collection->getConfiguration());
- }
- }
- // Ensure this entity's UUID does not exist with a different ID, regardless
- // of whether it's new or updated.
- $matching_entities = $storage->getQuery()
- ->condition('uuid', $this->uuid())
- ->execute();
- $matched_entity = reset($matching_entities);
- if (!empty($matched_entity) && ($matched_entity != $this->id()) && $matched_entity != $this->getOriginalId()) {
- throw new ConfigDuplicateUUIDException("Attempt to save a configuration entity '{$this->id()}' with UUID '{$this->uuid()}' when this UUID is already used for '$matched_entity'");
- }
- // If this entity is not new, load the original entity for comparison.
- if (!$this->isNew()) {
- $original = $storage->loadUnchanged($this->getOriginalId());
- // Ensure that the UUID cannot be changed for an existing entity.
- if ($original && ($original->uuid() != $this->uuid())) {
- throw new ConfigDuplicateUUIDException("Attempt to save a configuration entity '{$this->id()}' with UUID '{$this->uuid()}' when this entity already exists with UUID '{$original->uuid()}'");
- }
- }
- if (!$this->isSyncing()) {
- // Ensure the correct dependencies are present. If the configuration is
- // being written during a configuration synchronization then there is no
- // need to recalculate the dependencies.
- $this->calculateDependencies();
- }
- }
- /**
- * {@inheritdoc}
- */
- public function __sleep() {
- $keys_to_unset = [];
- if ($this instanceof EntityWithPluginCollectionInterface) {
- $vars = get_object_vars($this);
- foreach ($this->getPluginCollections() as $plugin_config_key => $plugin_collection) {
- // Save any changes to the plugin configuration to the entity.
- $this->set($plugin_config_key, $plugin_collection->getConfiguration());
- // If the plugin collections are stored as properties on the entity,
- // mark them to be unset.
- $keys_to_unset += array_filter($vars, function ($value) use ($plugin_collection) {
- return $plugin_collection === $value;
- });
- }
- }
- $vars = parent::__sleep();
- if (!empty($keys_to_unset)) {
- $vars = array_diff($vars, array_keys($keys_to_unset));
- }
- return $vars;
- }
- /**
- * {@inheritdoc}
- */
- public function calculateDependencies() {
- // All dependencies should be recalculated on every save apart from enforced
- // dependencies. This ensures stale dependencies are never saved.
- $this->dependencies = array_intersect_key($this->dependencies, ['enforced' => '']);
- if ($this instanceof EntityWithPluginCollectionInterface) {
- // Configuration entities need to depend on the providers of any plugins
- // that they store the configuration for.
- foreach ($this->getPluginCollections() as $plugin_collection) {
- foreach ($plugin_collection as $instance) {
- $this->calculatePluginDependencies($instance);
- }
- }
- }
- if ($this instanceof ThirdPartySettingsInterface) {
- // Configuration entities need to depend on the providers of any third
- // parties that they store the configuration for.
- foreach ($this->getThirdPartyProviders() as $provider) {
- $this->addDependency('module', $provider);
- }
- }
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function urlInfo($rel = 'edit-form', array $options = []) {
- // Unless language was already provided, avoid setting an explicit language.
- $options += ['language' => NULL];
- return parent::urlInfo($rel, $options);
- }
- /**
- * {@inheritdoc}
- */
- public function url($rel = 'edit-form', $options = []) {
- // Do not remove this override: the default value of $rel is different.
- return parent::url($rel, $options);
- }
- /**
- * {@inheritdoc}
- */
- public function link($text = NULL, $rel = 'edit-form', array $options = []) {
- // Do not remove this override: the default value of $rel is different.
- return parent::link($text, $rel, $options);
- }
- /**
- * {@inheritdoc}
- */
- public function toUrl($rel = 'edit-form', array $options = []) {
- // Unless language was already provided, avoid setting an explicit language.
- $options += ['language' => NULL];
- return parent::toUrl($rel, $options);
- }
- /**
- * {@inheritdoc}
- */
- public function getCacheTagsToInvalidate() {
- // Use cache tags that match the underlying config object's name.
- // @see \Drupal\Core\Config\ConfigBase::getCacheTags()
- return ['config:' . $this->getConfigDependencyName()];
- }
- /**
- * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
- *
- * Note that this function should only be called from implementations of
- * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
- * as dependencies are recalculated during every entity save.
- *
- * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
- */
- protected function addDependency($type, $name) {
- // A config entity is always dependent on its provider. There is no need to
- // explicitly declare the dependency. An explicit dependency on Core, which
- // provides some plugins, is also not needed.
- if ($type == 'module' && ($name == $this->getEntityType()->getProvider() || $name == 'core')) {
- return $this;
- }
- return $this->addDependencyTrait($type, $name);
- }
- /**
- * {@inheritdoc}
- */
- public function getDependencies() {
- $dependencies = $this->dependencies;
- if (isset($dependencies['enforced'])) {
- // Merge the enforced dependencies into the list of dependencies.
- $enforced_dependencies = $dependencies['enforced'];
- unset($dependencies['enforced']);
- $dependencies = NestedArray::mergeDeep($dependencies, $enforced_dependencies);
- }
- return $dependencies;
- }
- /**
- * {@inheritdoc}
- */
- public function getConfigDependencyName() {
- return $this->getEntityType()->getConfigPrefix() . '.' . $this->id();
- }
- /**
- * {@inheritdoc}
- */
- public function getConfigTarget() {
- // For configuration entities, use the config ID for the config target
- // identifier. This ensures that default configuration (which does not yet
- // have UUIDs) can be provided and installed with references to the target,
- // and also makes config dependencies more readable.
- return $this->id();
- }
- /**
- * {@inheritdoc}
- */
- public function onDependencyRemoval(array $dependencies) {
- $changed = FALSE;
- if (!empty($this->third_party_settings)) {
- $old_count = count($this->third_party_settings);
- $this->third_party_settings = array_diff_key($this->third_party_settings, array_flip($dependencies['module']));
- $changed = $old_count != count($this->third_party_settings);
- }
- return $changed;
- }
- /**
- * {@inheritdoc}
- *
- * Override to never invalidate the entity's cache tag; the config system
- * already invalidates it.
- */
- protected function invalidateTagsOnSave($update) {
- Cache::invalidateTags($this->getEntityType()->getListCacheTags());
- }
- /**
- * {@inheritdoc}
- *
- * Override to never invalidate the individual entities' cache tags; the
- * config system already invalidates them.
- */
- protected static function invalidateTagsOnDelete(EntityTypeInterface $entity_type, array $entities) {
- Cache::invalidateTags($entity_type->getListCacheTags());
- }
- /**
- * {@inheritdoc}
- */
- public function setThirdPartySetting($module, $key, $value) {
- $this->third_party_settings[$module][$key] = $value;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getThirdPartySetting($module, $key, $default = NULL) {
- if (isset($this->third_party_settings[$module][$key])) {
- return $this->third_party_settings[$module][$key];
- }
- else {
- return $default;
- }
- }
- /**
- * {@inheritdoc}
- */
- public function getThirdPartySettings($module) {
- return isset($this->third_party_settings[$module]) ? $this->third_party_settings[$module] : [];
- }
- /**
- * {@inheritdoc}
- */
- public function unsetThirdPartySetting($module, $key) {
- unset($this->third_party_settings[$module][$key]);
- // If the third party is no longer storing any information, completely
- // remove the array holding the settings for this module.
- if (empty($this->third_party_settings[$module])) {
- unset($this->third_party_settings[$module]);
- }
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getThirdPartyProviders() {
- return array_keys($this->third_party_settings);
- }
- /**
- * {@inheritdoc}
- */
- public static function preDelete(EntityStorageInterface $storage, array $entities) {
- parent::preDelete($storage, $entities);
- foreach ($entities as $entity) {
- if ($entity->isUninstalling() || $entity->isSyncing()) {
- // During extension uninstall and configuration synchronization
- // deletions are already managed.
- break;
- }
- // Fix or remove any dependencies.
- $config_entities = static::getConfigManager()->getConfigEntitiesToChangeOnDependencyRemoval('config', [$entity->getConfigDependencyName()], FALSE);
- /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $dependent_entity */
- foreach ($config_entities['update'] as $dependent_entity) {
- $dependent_entity->save();
- }
- foreach ($config_entities['delete'] as $dependent_entity) {
- $dependent_entity->delete();
- }
- }
- }
- /**
- * Gets the configuration manager.
- *
- * @return \Drupal\Core\Config\ConfigManager
- * The configuration manager.
- */
- protected static function getConfigManager() {
- return \Drupal::service('config.manager');
- }
- /**
- * {@inheritdoc}
- */
- public function isInstallable() {
- return TRUE;
- }
- /**
- * {@inheritdoc}
- */
- public function trustData() {
- $this->trustedData = TRUE;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function hasTrustedData() {
- return $this->trustedData;
- }
- /**
- * {@inheritdoc}
- */
- public function save() {
- $return = parent::save();
- $this->trustedData = FALSE;
- return $return;
- }
- }
|