interface DesignTokenInterface
Same name and namespace in other branches
- 11.x core/lib/Drupal/Core/Theme/Entity/DesignTokenInterface.php \Drupal\Core\Theme\Entity\DesignTokenInterface
Interface for design token config entity.
@internal This API is experimental.
Hierarchy
- interface \Drupal\Core\Theme\Entity\DesignTokenInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface
Expanded class hierarchy of DesignTokenInterface
All classes that implement DesignTokenInterface
2 files declare their use of DesignTokenInterface
- CssSelectorConstraintValidator.php in core/
lib/ Drupal/ Core/ Theme/ Plugin/ Validation/ Constraint/ CssSelectorConstraintValidator.php - DesignTokenConfigEntityKernelTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Theme/ DesignToken/ DesignTokenConfigEntityKernelTest.php
File
-
core/
lib/ Drupal/ Core/ Theme/ Entity/ DesignTokenInterface.php, line 16
Namespace
Drupal\Core\Theme\EntityView source
interface DesignTokenInterface extends ConfigEntityInterface {
/**
* The character used has placeholder for the dot character.
*
* Keyed lists in config cannot accept dot. So this character is used when
* saving are reading the scopes in config.
*/
public const DOT_CONVERSION_CHARACTER = '%';
/**
* Gets CSS variable name.
*
* @return string
* The CSS variable name.
*/
public function getCssVariableName() : string;
/**
* Gets scopes with design token plugin values according to the type.
*
* @return \Drupal\Core\Theme\DesignToken\DesignTokenValuePluginCollection
* The prepared scope collection.
*/
public function getScopes() : DesignTokenValuePluginCollection;
/**
* Exports the given tokens into CSS variables.
*
* @param \Drupal\Core\Theme\Entity\DesignTokenInterface[] $tokens
* The token entities.
*
* @return string
* The inline CSS.
*/
public static function toCss(array $tokens) : string;
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overrides |
|---|---|---|---|---|---|
| AccessibleInterface::access | public | function | Checks data value access. | 12 | |
| CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 37 | |
| CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 37 | |
| CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 28 | |
| ConfigEntityInterface::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | 2 | |
| ConfigEntityInterface::disable | public | function | Disables the configuration entity. | 2 | |
| ConfigEntityInterface::enable | public | function | Enables the configuration entity. | 2 | |
| ConfigEntityInterface::get | public | function | Returns the value of a property. | 2 | |
| ConfigEntityInterface::getDependencies | public | function | Gets the configuration dependencies. | 2 | |
| ConfigEntityInterface::hasTrustedData | public | function | Gets whether on not the data is trusted. | 2 | |
| ConfigEntityInterface::isInstallable | public | function | Checks whether this entity is installable. | 2 | |
| ConfigEntityInterface::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | 2 | |
| ConfigEntityInterface::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | 2 | |
| ConfigEntityInterface::set | public | function | Sets the value of a property. | 2 | |
| ConfigEntityInterface::setStatus | public | function | Sets the status of the configuration entity. | 2 | |
| ConfigEntityInterface::status | public | function | Returns whether the configuration entity is enabled. | 2 | |
| ConfigEntityInterface::trustData | Deprecated | public | function | Sets that the data should be trusted. | 2 |
| DesignTokenInterface::DOT_CONVERSION_CHARACTER | public | constant | The character used has placeholder for the dot character. | ||
| DesignTokenInterface::getCssVariableName | public | function | Gets CSS variable name. | 1 | |
| DesignTokenInterface::getScopes | public | function | Gets scopes with design token plugin values according to the type. | 1 | |
| DesignTokenInterface::toCss | public static | function | Exports the given tokens into CSS variables. | 1 | |
| EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 | |
| EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 | |
| EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 | |
| EntityInterface::delete | public | function | Deletes an entity permanently. | 2 | |
| EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 | |
| EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 | |
| EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 | |
| EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 | |
| EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 | |
| EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 | |
| EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 | |
| EntityInterface::getOriginal | public | function | Returns the original unchanged entity. | 2 | |
| EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 | |
| EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 | |
| EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 | |
| EntityInterface::id | public | function | Gets the identifier. | 2 | |
| EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 | |
| EntityInterface::label | public | function | Gets the label of the entity. | 2 | |
| EntityInterface::language | public | function | Gets the language of the entity. | 2 | |
| EntityInterface::load | public static | function | Loads an entity. | 2 | |
| EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 | |
| EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 | |
| EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 | |
| EntityInterface::postLoad | public static | function | Acts on loaded entities. | 2 | |
| EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 | |
| EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 | |
| EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 | |
| EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 | |
| EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 | |
| EntityInterface::save | public | function | Saves an entity permanently. | 2 | |
| EntityInterface::setOriginal | public | function | Sets the original unchanged entity. | 2 | |
| EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 | |
| EntityInterface::toArray | public | function | Gets an array of all property values. | 3 | |
| EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 | |
| EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 | |
| EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 | |
| EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 | |
| RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 | |
| RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 | |
| RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 | |
| RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 | |
| SynchronizableInterface::isSyncing | public | function | Returns whether this entity is being changed as part of a synchronization. | 1 | |
| SynchronizableInterface::setSyncing | public | function | Sets the status of the synchronization flag. | 1 | |
| ThirdPartySettingsInterface::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | 5 | |
| ThirdPartySettingsInterface::getThirdPartySetting | public | function | Gets the value of a third-party setting. | 5 | |
| ThirdPartySettingsInterface::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | 5 | |
| ThirdPartySettingsInterface::setThirdPartySetting | public | function | Sets the value of a third-party setting. | 5 | |
| ThirdPartySettingsInterface::unsetThirdPartySetting | public | function | Unsets a third-party setting. | 5 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.