class FilterAlign

Same name and namespace in other branches
  1. 8.9.x core/modules/filter/src/Plugin/Filter/FilterAlign.php \Drupal\filter\Plugin\Filter\FilterAlign
  2. 10 core/modules/filter/src/Plugin/Filter/FilterAlign.php \Drupal\filter\Plugin\Filter\FilterAlign
  3. 11.x core/modules/filter/src/Plugin/Filter/FilterAlign.php \Drupal\filter\Plugin\Filter\FilterAlign

Provides a filter to align elements.

Plugin annotation


@Filter(
  id = "filter_align",
  title = @Translation("Align images"),
  description = @Translation("Uses a <code>data-align</code> attribute on <code>&lt;img&gt;</code> tags to align images."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE
)

Hierarchy

Expanded class hierarchy of FilterAlign

File

core/modules/filter/src/Plugin/Filter/FilterAlign.php, line 19

Namespace

Drupal\filter\Plugin\Filter
View source 
class FilterAlign extends FilterBase {
    
    /**
     * {@inheritdoc}
     */
    public function process($text, $langcode) {
        $result = new FilterProcessResult($text);
        if (stristr($text, 'data-align') !== FALSE) {
            $dom = Html::load($text);
            $xpath = new \DOMXPath($dom);
            foreach ($xpath->query('//*[@data-align]') as $node) {
                // Read the data-align attribute's value, then delete it.
                $align = $node->getAttribute('data-align');
                $node->removeAttribute('data-align');
                // If one of the allowed alignments, add the corresponding class.
                if (in_array($align, [
                    'left',
                    'center',
                    'right',
                ])) {
                    $classes = $node->getAttribute('class');
                    $classes = strlen($classes) > 0 ? explode(' ', $classes) : [];
                    $classes[] = 'align-' . $align;
                    $node->setAttribute('class', implode(' ', $classes));
                }
            }
            $result->setProcessedText(Html::serialize($dom));
        }
        return $result;
    }
    
    /**
     * {@inheritdoc}
     */
    public function tips($long = FALSE) {
        if ($long) {
            return $this->t('
        <p>You can align images, videos, blockquotes and so on to the left, right or center. Examples:</p>
        <ul>
          <li>Align an image to the left: <code>&lt;img src="" data-align="left" /&gt;</code></li>
          <li>Align an image to the center: <code>&lt;img src="" data-align="center" /&gt;</code></li>
          <li>Align an image to the right: <code>&lt;img src="" data-align="right" /&gt;</code></li>
          <li>… and you can apply this to other elements as well: <code>&lt;video src="" data-align="center" /&gt;</code></li>
        </ul>');
        }
        else {
            return $this->t('You can align images (<code>data-align="center"</code>), but also videos, blockquotes, and so on.');
        }
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
FilterAlign::process public function Performs the filter processing. Overrides FilterInterface::process
FilterAlign::tips public function Generates a filter&#039;s tip. Overrides FilterBase::tips
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&#039;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&#039;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::settingsForm public function Generates a filter&#039;s settings form. Overrides FilterInterface::settingsForm 3
FilterBase::__construct public function 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.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.