Drupal 8  8.0.2
ConfigEntityInterface Interface Reference
Inheritance diagram for ConfigEntityInterface:

Public Member Functions

 enable ()
 
 disable ()
 
 setStatus ($status)
 
 setSyncing ($status)
 
 status ()
 
 isSyncing ()
 
 isUninstalling ()
 
 get ($property_name)
 
 set ($property_name, $value)
 
 calculateDependencies ()
 
 onDependencyRemoval (array $dependencies)
 
 getDependencies ()
 
 isInstallable ()
 
 trustData ()
 
 hasTrustedData ()
 
- Public Member Functions inherited from EntityInterface
 uuid ()
 
 id ()
 
 language ()
 
 isNew ()
 
 enforceIsNew ($value=TRUE)
 
 getEntityTypeId ()
 
 bundle ()
 
 label ()
 
 urlInfo ($rel= 'canonical', array $options=array())
 
 toUrl ($rel= 'canonical', array $options=array())
 
 url ($rel= 'canonical', $options=array())
 
 link ($text=NULL, $rel= 'canonical', array $options=[])
 
 toLink ($text=NULL, $rel= 'canonical', array $options=[])
 
 hasLinkTemplate ($key)
 
 uriRelationships ()
 
 save ()
 
 delete ()
 
 preSave (EntityStorageInterface $storage)
 
 postSave (EntityStorageInterface $storage, $update=TRUE)
 
 postCreate (EntityStorageInterface $storage)
 
 createDuplicate ()
 
 getEntityType ()
 
 referencedEntities ()
 
 getOriginalId ()
 
 getCacheTagsToInvalidate ()
 
 setOriginalId ($id)
 
 toArray ()
 
 getTypedData ()
 
 getConfigDependencyKey ()
 
 getConfigDependencyName ()
 
 getConfigTarget ()
 
- Public Member Functions inherited from AccessibleInterface
 access ($operation, AccountInterface $account=NULL, $return_as_object=FALSE)
 
- Public Member Functions inherited from CacheableDependencyInterface
 getCacheContexts ()
 
 getCacheTags ()
 
 getCacheMaxAge ()
 
- Public Member Functions inherited from RefinableCacheableDependencyInterface
 addCacheContexts (array $cache_contexts)
 
 addCacheTags (array $cache_tags)
 
 mergeCacheMaxAge ($max_age)
 
 addCacheableDependency ($other_object)
 
- Public Member Functions inherited from ThirdPartySettingsInterface
 setThirdPartySetting ($module, $key, $value)
 
 getThirdPartySetting ($module, $key, $default=NULL)
 
 getThirdPartySettings ($module)
 
 unsetThirdPartySetting ($module, $key)
 
 getThirdPartyProviders ()
 

Additional Inherited Members

- Static Public Member Functions inherited from EntityInterface
static load ($id)
 
static loadMultiple (array $ids=NULL)
 
static create (array $values=array())
 
static preCreate (EntityStorageInterface $storage, array &$values)
 
static preDelete (EntityStorageInterface $storage, array $entities)
 
static postDelete (EntityStorageInterface $storage, array $entities)
 
static postLoad (EntityStorageInterface $storage, array &$entities)
 

Detailed Description

Defines a common interface for configuration entities.

Member Function Documentation

calculateDependencies ( )

Calculates dependencies and stores them in the dependency property.

Returns
$this
See Also

Implemented in ViewUI, Migration, ConfigEntityBase, FieldStorageConfig, View, EntityDisplayBase, Block, ResponsiveImageStyle, ContentLanguageSettings, FieldConfig, Tour, RdfMapping, Editor, and EntityDisplayModeBase.

disable ( )

Disables the configuration entity.

Returns
$this

Implemented in ViewUI, ConfigEntityBase, and FilterFormat.

enable ( )

Enables the configuration entity.

Returns
$this

Implemented in ViewUI, and ConfigEntityBase.

Referenced by SearchPageRepository\setDefaultSearchPage().

Here is the caller graph for this function:

get (   $property_name)

Returns the value of a property.

Parameters
string$property_nameThe name of the property that should be returned.
Returns
mixed The property if it exists, or NULL otherwise.

Implemented in ConfigEntityBase.

getDependencies ( )

Gets the configuration dependencies.

Returns
array An array of dependencies, keyed by $type.
See Also

Implemented in ViewUI, and ConfigEntityBase.

Referenced by EntityDisplayTest\assertDependencyHelper(), and ConfigManager\callOnDependencyRemoval().

Here is the caller graph for this function:

hasTrustedData ( )

Gets whether on not the data is trusted.

Returns
bool TRUE if the configuration data is trusted, FALSE if not.

Implemented in ViewUI, and ConfigEntityBase.

isInstallable ( )

Checks whether this entity is installable.

For example, a default view might not be installable if the base table doesn't exist.

bool TRUE if the entity is installable, FALSE otherwise.

Implemented in ViewUI, ConfigEntityBase, View, and ConfigTest.

isSyncing ( )

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, ::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, ::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.

Returns
bool TRUE if the configuration entity is being created, updated, or deleted through the import process.

Implemented in ConfigEntityBase, and ViewUI.

isUninstalling ( )

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, ::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.

Returns
bool

Implemented in ConfigEntityBase, and ViewUI.

onDependencyRemoval ( array  $dependencies)

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.

Parameters
array$dependenciesAn array of dependencies that will be deleted keyed by dependency type. Dependency types are, for example, entity, module and theme.
Returns
bool TRUE if the entity has changed, FALSE if not.
bool TRUE if the entity has been changed as a result, FALSE if not.
See Also
::preDelete()
::uninstall()
::onDependencyRemoval()

Implemented in ViewUI, ConfigEntityBase, EntityDisplayBase, FilterFormat, FieldConfigBase, and ConfigTest.

Referenced by ConfigManager\callOnDependencyRemoval().

Here is the caller graph for this function:

set (   $property_name,
  $value 
)

Sets the value of a property.

Parameters
string$property_nameThe name of the property that should be set.
mixed$valueThe value the property should be set to.
Returns
$this

Implemented in Migration, and ConfigEntityBase.

Referenced by ConfigEntityStorageTest\testSaveRename(), and KeyValueEntityStorageTest\testSaveRenameConfigEntity().

Here is the caller graph for this function:

setStatus (   $status)

Sets the status of the configuration entity.

Parameters
bool$statusThe status of the configuration entity.
Returns
$this

Implemented in Migration, ConfigEntityBase, MigrationInterface, and ViewUI.

setSyncing (   $status)

Sets the status of the isSyncing flag.

Parameters
bool$statusThe status of the sync flag.
Returns
$this

Implemented in ConfigEntityBase, and ViewUI.

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.
Returns
bool Whether the entity is enabled or not.

Implemented in ViewUI, and ConfigEntityBase.

Referenced by Block\sort().

Here is the caller graph for this function:

trustData ( )

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.

Returns
$this
See Also
::createConfiguration()

Implemented in ViewUI, ConfigEntityBase, and Migration.


The documentation for this interface was generated from the following file: