You are here

Home » API reference » SpamSpan filter 8 » SpamspanTestForm.php

class SpamspanTestForm in SpamSpan filter 8

Same name and namespace in other branches
  1. 8.2 src/Form/SpamspanTestForm.php \Drupal\spamspan\Form\SpamspanTestForm

Implements an example form.

Hierarchy

Expanded class hierarchy of SpamspanTestForm

File

src/Form/SpamspanTestForm.php, line 11

Namespace

Drupal\spamspan\Form
View source 
class SpamspanTestForm extends FormBase {

  /**
   * {@inheritDoc}
   */
  public function getFormId() {
    return 'spamspan_test_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $plugin_manager = \Drupal::service('plugin.manager.filter');
    $configuration = $plugin_manager
      ->getDefinition('filter_spamspan');
    $defaults = $configuration['settings'];
    $filter = $plugin_manager
      ->createInstance('filter_spamspan', $configuration);
    $test_text = 'My work email is me@example.com and my home email is me@example.org.';
    $storage = $form_state
      ->getStorage();
    if (isset($storage['test_text'])) {
      $test_text = $storage['test_text'];
    }
    $default_list = [];
    foreach ($defaults as $name => $value) {
      $default_list[] = $name . ': <strong>' . htmlentities($value) . '</strong>';
    }
    $form['configure'] = [
      '#markup' => $this
        ->t('<p>The @dn module obfuscates email addresses to help prevent spambots from collecting them. It will produce clickable links if JavaScript is enabled and will show the email address as <code>example [at] example [dot] com</code> if the browser does not support JavaScript.</p>

<p>To configure the module:
    <ol>
        <li>Read the list of text formats at <a href="/admin/config/content/formats">Text formats</a>.</li>
        <li>Select <strong>configure</strong> for the format requiring email addresses.</li>
        <li>In <strong>Enable filters</strong>, select <em>@dn email address encoding filter</em>.</li>
        <li>In <strong>Filter processing order </strong>, move @dn below <em>Convert line breaks into HTML</em> and above <em>Convert URLs into links</em>.</li>
        <li>If you use the <strong>Limit allowed HTML tags</strong> filter, make sure that &lt;span&gt; is one of the allowed tags.</li>
        <li>Select <strong>@dn email address encoding filter</strong> to configure @dn for the text format.</li>
        <li>Select <strong>Save configuration</strong> to save your changes.</li>
    </ol>
</p>

<h2>Defaults</h2>
<p>The following defaults are used for new filters and for spamspan() when there is no filter specified.</p>
@defaults

<h2>Test spamspan()</h2>
<p>Test the @dn <code>spamspan()</code> function using the following <strong>Test text</strong> field. Enter text containing an email address then hit the Test button. We set up a default example to get you started.</p>', [
        '@defaults' => '<ul><li>' . implode('</li><li>', $default_list) . '</li></ul>',
        '@dn' => 'Spamspan',
      ]),
    ];
    $form['test_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Test text'),
      '#size' => 80,
      '#maxlength' => 200,
      '#default_value' => $test_text,
    ];
    $settings_form = $filter
      ->settingsForm([], $form_state);
    foreach ($defaults as $field => $value) {
      if (isset($settings_form['use_form'][$field])) {
        $form[$field] = $settings_form['use_form'][$field];
      }
      elseif (isset($settings_form[$field])) {
        $form[$field] = $settings_form[$field];
      }
      if (isset($storage[$field])) {
        $form[$field]['#default_value'] = $defaults[$field] = $storage[$field];
      }
    }
    $test_result = spamspan($test_text, $defaults);
    $form['test_js'] = [
      '#markup' => '<p>The result passed through spamspan() and processed by Javasript:</p><div style="background-color: #ccffcc;">' . $test_result . '</div>',
    ];
    $form['test_result'] = [
      '#markup' => '<p>The result passed through spamspan() but not processed by Javascript:</p><div style="background-color: #ccccff;">' . str_replace('class="spamspan"', '', $test_result) . '</div>',
    ];
    $form['test_as_html'] = [
      '#markup' => '<p>The HTML in the result:</p><div style="background-color: #ffcccc;">' . nl2br(htmlentities($test_result)) . '</div>',
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => t('Test'),
    ];
    $form['#attached']['library'][] = 'spamspan/obfuscate';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setStorage($form_state
      ->getValues());
    $form_state
      ->setRebuild();
  }

}

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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SpamspanTestForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SpamspanTestForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SpamspanTestForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.