class ConfigTestEncryptionMethod in Encrypt 8.3

ConfigTestEncryptionMethod testing class.

Plugin annotation

@EncryptionMethod(
  id = "config_test_encryption_method",
  title = @Translation("Config Test Encryption method"),
  description = "A test encryption method with configuration.",
  key_type = {"encryption"}
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\encrypt\Plugin\EncryptionMethod\EncryptionMethodBase implements ConfigurableInterface, DependentPluginInterface, EncryptionMethodInterface
      • class \Drupal\encrypt_test\Plugin\EncryptionMethod\ConfigTestEncryptionMethod implements EncryptionMethodInterface, EncryptionMethodPluginFormInterface

File

tests/modules/encrypt_test/src/Plugin/EncryptionMethod/ConfigTestEncryptionMethod.php, line 20

Namespace

Drupal\encrypt_test\Plugin\EncryptionMethod

class ConfigTestEncryptionMethod extends EncryptionMethodBase implements EncryptionMethodInterface, EncryptionMethodPluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function checkDependencies($text = NULL, $key = NULL) {
    $errors = [];
    return $errors;
  }

  /**
   * {@inheritdoc}
   */
  public function encrypt($text, $key, $options = []) {
    $prefix = $key . $this
      ->getConfiguration()['mode'];
    return str_rot13($prefix . $text);
  }

  /**
   * {@inheritdoc}
   */
  public function decrypt($text, $key, $options = []) {
    $decoded = str_rot13($text);
    $prefix = $key . $this
      ->getConfiguration()['mode'];

    // Strip out key, to retrieve original text.
    if (substr($decoded, 0, strlen($prefix)) == $prefix) {
      return substr($decoded, strlen($prefix));
    }
    else {
      return "invalid key";
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Cipher mode'),
      '#options' => [
        'ECB' => $this
          ->t('ECB'),
        'CBC' => $this
          ->t('CBC'),
        'CFB' => $this
          ->t('CFB'),
        'OFB' => $this
          ->t('OFB'),
      ],
      '#default_value' => 'CBC',
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->setConfiguration($form_state
      ->getValues());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigTestEncryptionMethod::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ConfigTestEncryptionMethod::checkDependencies	public	function	Check dependencies for the encryption method. Overrides EncryptionMethodInterface::checkDependencies
ConfigTestEncryptionMethod::decrypt	public	function	Decrypt text. Overrides EncryptionMethodInterface::decrypt
ConfigTestEncryptionMethod::encrypt	public	function	Encrypt text. Overrides EncryptionMethodInterface::encrypt
ConfigTestEncryptionMethod::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ConfigTestEncryptionMethod::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
EncryptionMethodBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
EncryptionMethodBase::canDecrypt	public	function	Define if encryption method can also decrypt. Overrides EncryptionMethodInterface::canDecrypt
EncryptionMethodBase::create	public static	function
EncryptionMethodBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
EncryptionMethodBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
EncryptionMethodBase::getLabel	public	function	Get the label. Overrides EncryptionMethodInterface::getLabel
EncryptionMethodBase::isDeprecated	public	function	Define if encryption method is deprecated. Overrides EncryptionMethodInterface::isDeprecated
EncryptionMethodBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
EncryptionMethodBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.