1. 8.3.x core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php ConfigEntityInterface
  2. 8.0.x core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php ConfigEntityInterface
  3. 8.1.x core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php ConfigEntityInterface
  4. 8.2.x core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php ConfigEntityInterface
  5. 8.4.x core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php ConfigEntityInterface

Defines a common interface for configuration entities.

Hierarchy

Expanded class hierarchy of ConfigEntityInterface

All classes that implement ConfigEntityInterface

Related topics

50 files declare their use of ConfigEntityInterface
Action.php in core/modules/system/src/Entity/Action.php
ActionConfigEntityInterface.php in core/modules/system/src/ActionConfigEntityInterface.php
AssertConfigEntityImportTrait.php in core/modules/config/src/Tests/AssertConfigEntityImportTrait.php
Block.php in core/modules/block/src/Entity/Block.php
BlockContentTypeInterface.php in core/modules/block_content/src/BlockContentTypeInterface.php

... See full list

File

core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php, line 13

Namespace

Drupal\Core\Config\Entity
View source
interface ConfigEntityInterface extends EntityInterface, ThirdPartySettingsInterface {

  /**
   * Enables the configuration entity.
   *
   * @return $this
   */
  public function enable();

  /**
   * Disables the configuration entity.
   *
   * @return $this
   */
  public function disable();

  /**
   * Sets the status of the configuration entity.
   *
   * @param bool $status
   *   The status of the configuration entity.
   *
   * @return $this
   */
  public function setStatus($status);

  /**
   * Sets the status of the isSyncing flag.
   *
   * @param bool $status
   *   The status of the sync flag.
   *
   * @return $this
   */
  public function setSyncing($status);

  /**
   * Returns whether the configuration entity is enabled.
   *
   * Status implementations for configuration entities should follow these
   * general rules:
   *   - Status does not affect the loading of entities. I.e. Disabling
   *     configuration entities should only have UI/access implications.
   *   - It should only take effect when a 'status' key is explicitly declared
   *     in the entity_keys info of a configuration entity's annotation data.
   *   - Each entity implementation (entity/controller) is responsible for
   *     checking and managing the status.
   *
   * @return bool
   *   Whether the entity is enabled or not.
   */
  public function status();

  /**
   * Returns whether this entity is being changed as part of an import process.
   *
   * If you are writing code that responds to a change in this entity (insert,
   * update, delete, presave, etc.), and your code would result in a
   * configuration change (whether related to this configuration entity, another
   * configuration entity, or non-entity configuration) or your code would
   * result in a change to this entity itself, you need to check and see if this
   * entity change is part of an import process, and skip executing your code if
   * that is the case.
   *
   * For example, \Drupal\node\Entity\NodeType::postSave() adds the default body
   * field to newly created node type configuration entities, which is a
   * configuration change. You would not want this code to run during an import,
   * because imported entities were already given the body field when they were
   * originally created, and the imported configuration includes all of their
   * currently-configured fields. On the other hand,
   * \Drupal\field\Entity\FieldStorageConfig::preSave() and the methods it calls
   * make sure that the storage tables are created or updated for the field
   * storage configuration entity, which is not a configuration change, and it
   * must be done whether due to an import or not. So, the first method should
   * check $entity->isSyncing() and skip executing if it returns TRUE, and the
   * second should not perform this check.
   *
   * @return bool
   *   TRUE if the configuration entity is being created, updated, or deleted
   *   through the import process.
   */
  public function isSyncing();

  /**
   * Returns whether this entity is being changed during the uninstall process.
   *
   * If you are writing code that responds to a change in this entity (insert,
   * update, delete, presave, etc.), and your code would result in a
   * configuration change (whether related to this configuration entity, another
   * configuration entity, or non-entity configuration) or your code would
   * result in a change to this entity itself, you need to check and see if this
   * entity change is part of an uninstall process, and skip executing your code
   * if that is the case.
   *
   * For example, \Drupal\language\Entity\ConfigurableLanguage::preDelete()
   * prevents the API from deleting the default language. However during an
   * uninstall of the language module it is expected that the default language
   * should be deleted.
   *
   * @return bool
   */
  public function isUninstalling();

  /**
   * Returns the value of a property.
   *
   * @param string $property_name
   *   The name of the property that should be returned.
   *
   * @return mixed
   *   The property if it exists, or NULL otherwise.
   */
  public function get($property_name);

  /**
   * Sets the value of a property.
   *
   * @param string $property_name
   *   The name of the property that should be set.
   * @param mixed $value
   *   The value the property should be set to.
   *
   * @return $this
   */
  public function set($property_name, $value);

  /**
   * Calculates dependencies and stores them in the dependency property.
   *
   * @return $this
   *
   * @see \Drupal\Core\Config\Entity\ConfigDependencyManager
   */
  public function calculateDependencies();

  /**
   * Informs the entity that entities it depends on will be deleted.
   *
   * This method allows configuration entities to remove dependencies instead
   * of being deleted themselves. Configuration entities can use this method to
   * avoid being unnecessarily deleted during an extension uninstallation.
   * For example, entity displays remove references to widgets and formatters if
   * the plugin that supplies them depends on a module that is being
   * uninstalled.
   *
   * If this method returns TRUE then the entity needs to be re-saved by the
   * caller for the changes to take effect. Implementations should not save the
   * entity.
   *
   * @param array $dependencies
   *   An array of dependencies that will be deleted keyed by dependency type.
   *   Dependency types are, for example, entity, module and theme.
   *
   * @return bool
   *   TRUE if the entity has been changed as a result, FALSE if not.
   *
   * @see \Drupal\Core\Config\Entity\ConfigDependencyManager
   * @see \Drupal\Core\Config\ConfigEntityBase::preDelete()
   * @see \Drupal\Core\Config\ConfigManager::uninstall()
   * @see \Drupal\Core\Entity\EntityDisplayBase::onDependencyRemoval()
   */
  public function onDependencyRemoval(array $dependencies);

  /**
   * Gets the configuration dependencies.
   *
   * @return array
   *   An array of dependencies, keyed by $type.
   *
   * @see \Drupal\Core\Config\Entity\ConfigDependencyManager
   */
  public function getDependencies();

  /**
   * Checks whether this entity is installable.
   *
   * For example, a default view might not be installable if the base table
   * doesn't exist.
   *
   * @retun bool
   *   TRUE if the entity is installable, FALSE otherwise.
   */
  public function isInstallable();

  /**
   * Sets that the data should be trusted.
   *
   * If the data is trusted then dependencies will not be calculated on save and
   * schema will not be used to cast the values. Generally this is only used
   * during module and theme installation. Once the config entity has been saved
   * the data will no longer be marked as trusted. This is an optimization for
   * creation of configuration during installation.
   *
   * @return $this
   *
   * @see \Drupal\Core\Config\ConfigInstaller::createConfiguration()
   */
  public function trustData();

  /**
   * Gets whether on not the data is trusted.
   *
   * @return bool
   *   TRUE if the configuration data is trusted, FALSE if not.
   */
  public function hasTrustedData();

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
AccessibleInterface::access public function Checks data value access. Overrides AccessibleInterface::access
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property.
ConfigEntityInterface::disable public function Disables the configuration entity.
ConfigEntityInterface::enable public function Enables the configuration entity.
ConfigEntityInterface::get public function Returns the value of a property.
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies.
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted.
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable.
ConfigEntityInterface::isSyncing public function Returns whether this entity is being changed as part of an import process.
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process.
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted.
ConfigEntityInterface::set public function Sets the value of a property.
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity.
ConfigEntityInterface::setSyncing public function Sets the status of the isSyncing flag.
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled.
ConfigEntityInterface::trustData public function Sets that the data should be trusted.
EntityInterface::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityInterface::createDuplicate public function Creates a duplicate of the entity. Overrides EntityInterface::createDuplicate
EntityInterface::delete public function Deletes an entity permanently. Overrides EntityInterface::delete
EntityInterface::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget
EntityInterface::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityInterface::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId
EntityInterface::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityInterface::id public function Gets the identifier. Overrides EntityInterface::id
EntityInterface::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew
EntityInterface::label public function Gets the label of the entity. Overrides EntityInterface::label
EntityInterface::language public function Gets the language of the entity. Overrides EntityInterface::language
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link
EntityInterface::load public static function Loads an entity. Overrides EntityInterface::load
EntityInterface::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete
EntityInterface::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave
EntityInterface::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityInterface::preSave
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
EntityInterface::save public function Saves an entity permanently. Overrides EntityInterface::save
EntityInterface::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId
EntityInterface::toArray public function Gets an array of all property values. Overrides EntityInterface::toArray
EntityInterface::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityInterface::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityInterface::url Deprecated public function Gets the public URL for this entity. Overrides EntityInterface::url
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. Overrides EntityInterface::urlInfo
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information.
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting.
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module.
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting.
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting.