You are here

Home » API reference » Key 8 » KeyInterface.php

interface KeyInterface in Key 8

Provides an interface defining a Key entity.

Hierarchy

Expanded class hierarchy of KeyInterface

All classes that implement KeyInterface

8 files declare their use of KeyInterface
ConfigKeyProvider.php in src/Plugin/KeyProvider/ConfigKeyProvider.php
EnvKeyProvider.php in src/Plugin/KeyProvider/EnvKeyProvider.php
FileKeyProvider.php in src/Plugin/KeyProvider/FileKeyProvider.php
Key.php in src/Entity/Key.php
KeyProviderBase.php in src/Plugin/KeyProviderBase.php

... See full list

File

src/KeyInterface.php, line 10

Namespace

Drupal\key
View source 
interface KeyInterface extends ConfigEntityInterface {

  /**
   * Gets the description of the key.
   *
   * @return string
   *   The description of this key.
   */
  public function getDescription();

  /**
   * Returns the configured plugins for the key.
   *
   * @return \Drupal\key\Plugin\KeyPluginInterface[]
   *   An array of plugins, indexed by plugin type.
   */
  public function getPlugins();

  /**
   * Returns the configured plugin of the requested type.
   *
   * @param string $type
   *   The plugin type to return.
   *
   * @return \Drupal\key\Plugin\KeyPluginInterface
   *   The plugin.
   */
  public function getPlugin($type);

  /**
   * Sets a plugin of the requested type and plugin ID.
   *
   * @param string $type
   *   The plugin type.
   * @param string $id
   *   The plugin ID.
   */
  public function setPlugin($type, $id);

  /**
   * Returns the configured key type for the key.
   *
   * @return \Drupal\key\Plugin\KeyTypeInterface
   *   The key type associated with the key.
   */
  public function getKeyType();

  /**
   * Returns the configured key provider for the key.
   *
   * @return \Drupal\key\Plugin\KeyProviderInterface
   *   The key provider associated with the key.
   */
  public function getKeyProvider();

  /**
   * Returns the configured key input for the key.
   *
   * @return \Drupal\key\Plugin\KeyInputInterface
   *   The key input associated with the key.
   */
  public function getKeyInput();

  /**
   * Gets the value of the key.
   *
   * @return string
   *   The value of the key.
   */
  public function getKeyValue();

  /**
   * Gets the values of the key.
   *
   * @return array
   *   The values of the key.
   */
  public function getKeyValues();

  /**
   * Sets the value of the key.
   *
   * @param string $key_value
   *   The key value to set.
   *
   * @return string|bool
   *   The key value or FALSE if the value could not be set, because the
   *   provider does not support setting a key value, for instance.
   */
  public function setKeyValue($key_value);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
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 public function Sets that the data should be trusted. 2
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::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::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 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. 3
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::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::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
KeyInterface::getDescription public function Gets the description of the key. 1
KeyInterface::getKeyInput public function Returns the configured key input for the key. 1
KeyInterface::getKeyProvider public function Returns the configured key provider for the key. 1
KeyInterface::getKeyType public function Returns the configured key type for the key. 1
KeyInterface::getKeyValue public function Gets the value of the key. 1
KeyInterface::getKeyValues public function Gets the values of the key. 1
KeyInterface::getPlugin public function Returns the configured plugin of the requested type. 1
KeyInterface::getPlugins public function Returns the configured plugins for the key. 1
KeyInterface::setKeyValue public function Sets the value of the key. 1
KeyInterface::setPlugin public function Sets a plugin of the requested type and plugin ID. 1
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