You are here

Home » API reference » Obfuscate Email 8 » ObfuscateEmail.php

class ObfuscateEmail in Obfuscate Email 8

Provide a filter to obfuscate mailto anchor tags and optionally replace inner text.

Plugin annotation


@Filter(
  id = "obfuscate_email",
  title = @Translation("Obfuscate Email"),
  description = @Translation("Transform <code>mailto</code> anchors into obfuscated markup."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE,
  settings = {
    "click" = FALSE,
    "click_label" = @Translation("Click here to show mail address"),
  },
)

Hierarchy

Expanded class hierarchy of ObfuscateEmail

File

src/Plugin/Filter/ObfuscateEmail.php, line 24

Namespace

Drupal\obfuscate_email\Plugin\Filter
View source 
class ObfuscateEmail extends FilterBase {

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['click'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Force user to click link to display mail address.'),
      '#default_value' => $this->settings['click'],
    ];
    $form['click_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Text to show on link'),
      '#default_value' => $this->settings['click_label'],
      '#states' => [
        'visible' => [
          ':input[name="filters[obfuscate_email][settings][click]"]' => array(
            'checked' => TRUE,
          ),
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $result = new FilterProcessResult($text);
    if (stristr($text, 'mailto') === FALSE) {
      return $result;
    }
    $dom = Html::load($text);
    $xpath = new \DOMXPath($dom);

    /** @var \DOMElement $domElement */
    foreach ($xpath
      ->query('//a[starts-with(@href, "mailto:")]') as $domElement) {

      // Read the href attribute value and delete it.
      $href = str_replace('mailto:', '', $domElement
        ->getAttribute('href'));
      $domElement
        ->setAttribute('href', '#');

      // Convert to rot13
      $mail_string = str_rot13(str_replace([
        '.',
        '@',
      ], [
        '/dot/',
        '/at/',
      ], $href));
      $domElement
        ->setAttribute('data-mail-to', $mail_string);

      // Replace occurrence of the address in the anchor text.
      if (strpos($domElement->nodeValue, $href) !== FALSE) {
        $domElement->nodeValue = str_replace($href, '@email', $domElement->nodeValue);
        $domElement
          ->setAttribute('data-replace-inner', '@email');
        if ($this->settings['click']) {
          $domElement
            ->setAttribute('data-mail-click-link', true);
          $domElement->nodeValue = $this
            ->t($this->settings['click_label']);
          $domElement
            ->setAttribute('data-replace-inner', $domElement->nodeValue);
        }
      }
    }
    $result
      ->setProcessedText(Html::serialize($dom));
    return $result;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FilterBase::$provider public property The name of the provider that owns this filter.
FilterBase::$settings public property An associative array containing the configured settings of this filter.
FilterBase::$status public property A Boolean indicating whether this filter is enabled.
FilterBase::$weight public property The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
FilterBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription public function Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions public function Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions 4
FilterBase::getLabel public function Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType public function Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare public function Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
FilterBase::tips public function Generates a filter's tip. Overrides FilterInterface::tips 9
FilterBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 4
FilterInterface::TYPE_HTML_RESTRICTOR constant HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE constant Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE constant Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE constant Reversible transformation filters.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ObfuscateEmail::process public function Performs the filter processing. Overrides FilterInterface::process
ObfuscateEmail::settingsForm public function Generates a filter's settings form. Overrides FilterBase::settingsForm
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.