abstract class AESPluginBase in AES encryption 8.2

Provides a base class for all cryptor plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\aes\Plugin\AESPluginBase

2 files declare their use of AESPluginBase

Mcrypt.php in src/Plugin/AES/Mcrypt.php

Reverse.php in src/Plugin/AES/Reverse.php

File

src/Plugin/AESPluginBase.php, line 10

Namespace

Drupal\aes\Plugin

abstract class AESPluginBase extends PluginBase {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * @param string $data
   *   Data to be encoded.
   * @param bool|string $key
   *   Optional key to be used when encoding.
   * @param bool|string $cipher
   *   Optional cipher to be used when encoding. If present, contain one of the following strings:
   *   rijndael-128, rijndael-192, rijndael-256
   *
   * @return mixed encoded data.
   */
  public abstract function encrypt($data, $key = FALSE, $cipher = FALSE);

  /**
   * @param string $data
   *   Data to be decoded.
   * @param bool|string $key
   *   Optional key to be used for decoding.
   * @param bool|string $cipher
   *   Optional cipher to be used for decoding. If present, contain one of the following strings:
   *   rijndael-128, rijndael-192, rijndael-256
   *
   * @return string decoded string.
   */
  public abstract function decrypt($data, $key = FALSE, $cipher = FALSE);

}

Members

Name	Modifiers	Type	Description	Overrides
AESPluginBase::decrypt	abstract public	function		2
AESPluginBase::encrypt	abstract public	function		2
AESPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	2
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.