Defines the interface common for all configuration entities.
Expanded class hierarchy of ConfigEntityInterface
All classes that implement ConfigEntityInterface
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();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigEntityInterface:: |
public | function | Returns the original ID. | 2 |
ConfigEntityInterface:: |
public | function | Sets the original ID. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
EntityInterface:: |
public | function | Returns the entity identifier (the entity's machine name or numeric ID). | 3 |
EntityInterface:: |
public | function | Returns the entity UUID (Universally Unique Identifier). | 3 |
EntityInterface:: |
public | function | Returns whether the entity is new. | 3 |
EntityInterface:: |
public | function | Returns whether a new revision should be created on save. | 3 |
EntityInterface:: |
public | function | Enforces an entity to be saved as a new revision. | 3 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 3 |
EntityInterface:: |
public | function | Returns the type of the entity. | 3 |
EntityInterface:: |
public | function | Returns the bundle of the entity. | 3 |
EntityInterface:: |
public | function | Returns the label of the entity. | 3 |
EntityInterface:: |
public | function | Returns the URI elements of the entity. | 3 |
EntityInterface:: |
public | function | Returns a list of URI relationships supported by this entity. | 3 |
EntityInterface:: |
public | function | Saves an entity permanently. | 3 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 3 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 3 |
EntityInterface:: |
public | function | Returns the info of the type of the entity. | 3 |
EntityInterface:: |
public | function | Returns the revision identifier of the entity. | 3 |
EntityInterface:: |
public | function | Checks if this entity is the default revision. | 3 |
EntityInterface:: |
public | function | Retrieves the exportable properties of the entity. | 3 |
EntityInterface:: |
public | function | Gets a backward compatibility decorator entity. | 3 |
EntityInterface:: |
public | function | Removes any possible (backward compatibility) decorator in use. | 3 |
EntityInterface:: |
public | function | Returns the translation support status. | 3 |
ComplexDataInterface:: |
public | function | Gets a property object. | 7 |
ComplexDataInterface:: |
public | function | Sets a property value. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property objects. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property values. | 7 |
ComplexDataInterface:: |
public | function | Sets multiple property values. | 7 |
ComplexDataInterface:: |
public | function | Gets the definition of a contained property. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property definitions of contained properties. | 7 |
ComplexDataInterface:: |
public | function | Determines whether the data structure is empty. | 7 |
ComplexDataInterface:: |
public | function | React to changes to a child property. | 7 |
TypedDataInterface:: |
public | function | Gets the data type. | 5 |
TypedDataInterface:: |
public | function | Gets the data definition. | 4 |
TypedDataInterface:: |
public | function | Gets the data value. | 4 |
TypedDataInterface:: |
public | function | Sets the data value. | 4 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 4 |
TypedDataInterface:: |
public | function | Gets a list of validation constraints. | 4 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 4 |
TypedDataInterface:: |
public | function | Returns the name of a property or item. | 4 |
TypedDataInterface:: |
public | function | Returns the parent data structure; i.e. either complex data or a list. | 4 |
TypedDataInterface:: |
public | function | Returns the root of the typed data tree. | 4 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 4 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 4 |
AccessibleInterface:: |
public | function | Checks data value access. | 5 |
TranslatableInterface:: |
public | function | Returns the default language. | 3 |
TranslatableInterface:: |
public | function | Returns the languages the data is translated to. | 3 |
TranslatableInterface:: |
public | function | Gets a translation of the data. | 3 |