interface ConfigEntityInterface

Defines the interface common for all configuration entities.

Hierarchy

Expanded class hierarchy of ConfigEntityInterface

All classes that implement ConfigEntityInterface

22 files declare their use of ConfigEntityInterface
ActionConfigEntityInterface.php in drupal/core/modules/system/lib/Drupal/system/ActionConfigEntityInterface.php
Contains \Drupal\system\ActionConfigEntityInterface.
BlockInterface.php in drupal/core/modules/block/lib/Drupal/block/BlockInterface.php
Contains \Drupal\block\Plugin\Core\Entity\BlockInterface.
BreakpointGroupInterface.php in drupal/core/modules/breakpoint/lib/Drupal/breakpoint/BreakpointGroupInterface.php
Contains \Drupal\breakpoint\Plugin\Core\Entity\BreakpointGroupInterface.
BreakpointInterface.php in drupal/core/modules/breakpoint/lib/Drupal/breakpoint/BreakpointInterface.php
Contains \Drupal\breakpoint\Plugin\Core\Entity\BreakpointInterface.
CategoryInterface.php in drupal/core/modules/contact/lib/Drupal/contact/CategoryInterface.php
Contains \Drupal\contact\Plugin\Core\Entity\CategoryInterface.

... See full list

File

drupal/core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php, line 15
Definition of Drupal\Core\Config\Entity\ConfigEntityInterface.

Namespace

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

  /**
   * Returns the original ID.
   *
   * @return string|null
   *   The original ID, if any.
   */
  public function getOriginalID();

  /**
   * Sets the original ID.
   *
   * @param string $id
   *   The new ID to set as original ID.
   *
   * @return void
   */
  public function setOriginalID($id);

  /**
   * Enables the configuration entity.
   *
   * @return \Drupal\Core\Config\Entity\ConfigEntityInterface
   *   The configuration entity.
   */
  public function enable();

  /**
   * Disables the configuration entity.
   *
   * @return \Drupal\Core\Config\Entity\ConfigEntityInterface
   *   The configuration entity.
   */
  public function disable();

  /**
   * Sets the status of the configuration entity.
   *
   * @param bool $status
   *   The status of the configuration entity.
   *
   * @return \Drupal\Core\Config\Entity\ConfigEntityInterface
   *   The class instance that this method is called on.
   */
  public function setStatus($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 entitys annotation data.
   *   - Each entity implementation (entity/controller) is responsible for
   *     checking and managing the status.
   *
   * @return bool
   */
  public function status();

}

Members

Name Modifiers Type Descriptionsort descending Overrides
AccessibleInterface::access public function Checks data value access. 5
EntityInterface::isDefaultRevision public function Checks if this entity is the default revision. 3
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 3
EntityInterface::delete public function Deletes an entity permanently. 3
ComplexDataInterface::isEmpty public function Determines whether the data structure is empty. 7
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 3
EntityInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 3
EntityInterface::getBCEntity public function Gets a backward compatibility decorator entity. 3
TypedDataInterface::getConstraints public function Gets a list of validation constraints. 4
ComplexDataInterface::get public function Gets a property object. 7
TranslatableInterface::getTranslation public function Gets a translation of the data. 3
ComplexDataInterface::getPropertyDefinitions public function Gets an array of property definitions of contained properties. 7
ComplexDataInterface::getProperties public function Gets an array of property objects. 7
ComplexDataInterface::getPropertyValues public function Gets an array of property values. 7
TypedDataInterface::getDefinition public function Gets the data definition. 4
TypedDataInterface::getType public function Gets the data type. 5
TypedDataInterface::getValue public function Gets the data value. 4
ComplexDataInterface::getPropertyDefinition public function Gets the definition of a contained property. 7
ComplexDataInterface::onChange public function React to changes to a child property. 7
EntityInterface::getNGEntity public function Removes any possible (backward compatibility) decorator in use. 3
EntityInterface::getExportProperties public function Retrieves the exportable properties of the entity. 3
EntityInterface::uriRelationships public function Returns a list of URI relationships supported by this entity. 3
TypedDataInterface::getString public function Returns a string representation of the data. 4
EntityInterface::bundle public function Returns the bundle of the entity. 3
TranslatableInterface::language public function Returns the default language. 3
EntityInterface::id public function Returns the entity identifier (the entity's machine name or numeric ID). 3
EntityInterface::uuid public function Returns the entity UUID (Universally Unique Identifier). 3
EntityInterface::entityInfo public function Returns the info of the type of the entity. 3
EntityInterface::label public function Returns the label of the entity. 3
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 3
TypedDataInterface::getName public function Returns the name of a property or item. 4
ConfigEntityInterface::getOriginalID public function Returns the original ID. 2
TypedDataInterface::getParent public function Returns the parent data structure; i.e. either complex data or a list. 4
TypedDataInterface::getPropertyPath public function Returns the property path of the data. 4
EntityInterface::getRevisionId public function Returns the revision identifier of the entity. 3
TypedDataInterface::getRoot public function Returns the root of the typed data tree. 4
EntityInterface::isTranslatable public function Returns the translation support status. 3
EntityInterface::entityType public function Returns the type of the entity. 3
EntityInterface::uri public function Returns the URI elements of the entity. 3
EntityInterface::isNewRevision public function Returns whether a new revision should be created on save. 3
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
EntityInterface::isNew public function Returns whether the entity is new. 3
EntityInterface::save public function Saves an entity permanently. 3
ComplexDataInterface::set public function Sets a property value. 7
ComplexDataInterface::setPropertyValues public function Sets multiple property values. 7
TypedDataInterface::setContext public function Sets the context of a property or item via a context aware parent. 4
TypedDataInterface::setValue public function Sets the data value. 4
ConfigEntityInterface::setOriginalID public function Sets the original ID. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
TypedDataInterface::validate public function Validates the currently set data value. 4