You are here

Home » API reference » Wordfilter 8.2 » WordFilter.php

class WordFilter in Wordfilter 8.2

Plugin annotation


@Filter(
  id = "wordfilter",
  title = @Translation("Apply filtering of words"),
  description = @Translation("Filter out words by given Wordfilter configurations (choose below)."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE,
)

Hierarchy

Expanded class hierarchy of WordFilter

File

src/Plugin/Filter/WordFilter.php, line 18

Namespace

Drupal\wordfilter\Plugin\Filter
View source 
class WordFilter extends FilterBase {

  /**
   * A list of all active Wordfilter configurations.
   *
   * @see ::activeWordfilterConfigs()
   *
   * @var \Drupal\wordfilter\Entity\WordfilterConfigurationInterface[]
   */
  protected $active_configs = NULL;

  /**
   * Get a list of active Wordfilter configurations for this filter.
   *
   * @return \Drupal\wordfilter\Entity\WordfilterConfigurationInterface[]
   */
  public function activeWordfilterConfigs() {
    if (!isset($this->active_configs)) {
      $settings_active = !empty($this->settings['active_wordfilter_configs']) ? $this->settings['active_wordfilter_configs'] : [];
      if (!empty($settings_active)) {
        $storage = \Drupal::entityTypeManager()
          ->getStorage('wordfilter_configuration');
        $this->active_configs = $storage
          ->loadMultiple($settings_active);
      }
      else {
        $this->active_configs = [];
      }
    }
    return $this->active_configs;
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $active_configs = $this
      ->activeWordfilterConfigs();
    if (!empty($active_configs)) {
      foreach ($active_configs as $wordfilter_config) {
        $process = $wordfilter_config
          ->getProcess();
        $text = $process
          ->filterWords($text, $wordfilter_config, $langcode);
      }
    }
    return new FilterProcessResult($text);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $storage = \Drupal::entityTypeManager()
      ->getStorage('wordfilter_configuration');
    $wordfilter_configs = $storage
      ->loadMultiple();
    foreach ($wordfilter_configs as $key => $config) {
      $wordfilter_configs[$key] = $config
        ->label();
    }
    $descriptions = [
      $this
        ->t('Choose the available Wordfilter configurations as active filters.'),
    ];
    if (\Drupal::currentUser()
      ->hasPermission('access wordfilter configurations page')) {
      $descriptions[] = $this
        ->t('You can create and manage Wordfilter configurations at the <a target="_blank" href=":url">Wordfilter configuration page</a>.', [
        ':url' => '/admin/config/wordfilter_configuration',
      ]);
    }
    $form['active_wordfilter_configs'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Active Wordfilter configurations'),
      '#options' => $wordfilter_configs,
      '#default_value' => !empty($this->settings['active_wordfilter_configs']) ? $this->settings['active_wordfilter_configs'] : [],
      '#description' => \Drupal::theme()
        ->render('item_list', [
        'items' => $descriptions,
      ]),
      '#multiple' => TRUE,
    );
    return $form;
  }

}

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.
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.
WordFilter::$active_configs protected property A list of all active Wordfilter configurations.
WordFilter::activeWordfilterConfigs public function Get a list of active Wordfilter configurations for this filter.
WordFilter::process public function Performs the filter processing. Overrides FilterInterface::process
WordFilter::settingsForm public function Generates a filter's settings form. Overrides FilterBase::settingsForm