interface KeyProviderSettableValueInterface in Key 8

Defines an interface for provider plugins that allow setting a key value.

Hierarchy

• interface \Drupal\key\Plugin\KeyProviderSettableValueInterface

4 files declare their use of KeyProviderSettableValueInterface

ConfigKeyProvider.php in src/Plugin/KeyProvider/ConfigKeyProvider.php

Key.php in src/Entity/Key.php

KeyFormBase.php in src/Form/KeyFormBase.php

State.php in tests/modules/key_test/src/Plugin/KeyProvider/State.php

File

src/Plugin/KeyProviderSettableValueInterface.php, line 10

Namespace

Drupal\key\Plugin

interface KeyProviderSettableValueInterface {

  /**
   * Sets the value of a key.
   *
   * @param \Drupal\key\KeyInterface $key
   *   The key whose value will be set.
   * @param string $key_value
   *   The key value.
   *
   * @return bool
   *   TRUE if successful, FALSE if unsuccessful.
   */
  public function setKeyValue(KeyInterface $key, $key_value);

  /**
   * Deletes the value of a key.
   *
   * @param \Drupal\key\KeyInterface $key
   *   The key whose value will be deleted.
   *
   * @return string
   *   TRUE if successful, FALSE if unsuccessful.
   */
  public function deleteKeyValue(KeyInterface $key);

}

Members

Name	Modifiers	Type	Description	Overrides
KeyProviderSettableValueInterface::deleteKeyValue	public	function	Deletes the value of a key.	2
KeyProviderSettableValueInterface::setKeyValue	public	function	Sets the value of a key.	2