class FilterNoFollowList in Nofollow List 8

Provides a filter to add nofollow to links.

Plugin annotation


@Filter(
  id = "nofollowlist",
  title = @Translation("nofollow list"),
  description = @Translation("Provides a nofollowlist filter."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE,
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\filter\Plugin\FilterBase implements FilterInterface
    class \Drupal\nofollowlist\Plugin\Filter\FilterNoFollowList

Expanded class hierarchy of FilterNoFollowList

File

src/Plugin/Filter/FilterNoFollowList.php, line 20

Namespace

Drupal\nofollowlist\Plugin\Filter

View source

class FilterNoFollowList extends FilterBase {

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $list = preg_split('/\\s+/', $this->settings['nofollowlist_hosts']);
    $html_dom = Html::load($text);
    $links = $html_dom
      ->getElementsByTagName('a');
    foreach ($links as $link) {
      $url = parse_url($link
        ->getAttribute('href'));

      // Handle whitelist option.
      if ($this->settings['nofollowlist_option'] == 'white') {

        // If there is a host present and it is not in the list of allowed hosts
        // we add rel="nofollow".
        if (isset($url['host']) && !in_array($url['host'], $list)) {
          $link
            ->setAttribute('rel', 'nofollow');
        }
      }
      elseif ($this->settings['nofollowlist_option'] == 'black') {

        // If there is a host present and it is in the list of disallowed hosts
        // we add rel="nofollow".
        if (isset($url['host']) && in_array($url['host'], $list)) {
          $link
            ->setAttribute('rel', 'nofollow');
        }
      }
    }
    $text = Html::serialize($html_dom);
    return new FilterProcessResult($text);
  }

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

    // Form to add radio button options to opt between whitelist & blacklist
    // links.
    $form['nofollowlist_option'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Hosts list option'),
      '#description' => $this
        ->t('If you choose the whitelist option, be sure to add your own site to the list!'),
      '#options' => [
        'black' => $this
          ->t('Blacklist: Add rel="nofollow" to links leading to the listed hosts.'),
        'white' => $this
          ->t('Whitelist: Add rel="nofollow" to all links <b>except</b> the listed hosts.'),
      ],
      '#default_value' => $this->settings['nofollowlist_option'],
    ];

    // Form to add textarea to enter links.
    $form['nofollowlist_hosts'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Nofollowlist hosts'),
      '#description' => $this
        ->t('Add one host per line. Ex: en.wikipedia.org'),
      '#default_value' => $this->settings['nofollowlist_hosts'],
    ];
    return $form;
  }

}

Members

Name	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.
FilterNoFollowList::process	public	function	Performs the filter processing. Overrides FilterInterface::process
FilterNoFollowList::settingsForm	public	function	Generates a filter's settings form. Overrides FilterBase::settingsForm
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.

You are here

class FilterNoFollowList in Nofollow List 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation