You are here

Home » API reference » Bootstrap Utilities - Text editor filters 8 » TableFilter.php

class TableFilter in Bootstrap Utilities - Text editor filters 8

Add Bootstrap class to any tables.

Plugin annotation


@Filter(
  id = "bootstrap_utilities_table_filter",
  title = @Translation("Bootstrap Utilities - Table Classes"),
  description = @Translation("This filter allows you to add default Bootstrap classes to a table, controlled by settings"),
  settings = {
    "table_remove_width_height" = TRUE,
    "table_row_striping" = FALSE,
    "table_bordered" = FALSE,
    "table_row_hover" = FALSE,
    "table_small" = FALSE,
  },
  type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE
)

Hierarchy

Expanded class hierarchy of TableFilter

File

src/Plugin/Filter/TableFilter.php, line 27

Namespace

Drupal\bootstrap_utilities\Plugin\Filter
View source 
class TableFilter extends FilterBase {

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['table_remove_width_height'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remove <code>width</code> and <code>height</code> attributes from table cells.'),
      '#default_value' => $this->settings['table_remove_width_height'],
    ];
    $form['table_row_striping'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Striped rows'),
      '#default_value' => $this->settings['table_row_striping'],
      '#description' => $this
        ->t('Adds <code>.table-striped</code> to add zebra-striping to any table row within the <code>&lt;tbody&gt;</code>.'),
    ];
    $form['table_bordered'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Bordered table'),
      '#default_value' => $this->settings['table_bordered'],
      '#description' => $this
        ->t('Adds <code>.table-bordered</code> for borders on all sides of the table and cells.'),
    ];
    $form['table_row_hover'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hoverable rows'),
      '#default_value' => $this->settings['table_row_hover'],
      '#description' => $this
        ->t('Adds <code>.table-hover</code> to enable a hover state on table rows within a <code>&lt;tbody&gt;</code>.'),
    ];
    $form['table_small'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Small table'),
      '#default_value' => $this->settings['table_small'],
      '#description' => $this
        ->t('Adds <code>.table-sm</code> to make tables more compact by cutting cell padding in half.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $result = new FilterProcessResult($text);
    if (stristr($text, 'table') !== FALSE) {
      $setting_classes = [];
      $setting_classes[] = 'table';
      if ($this->settings['table_row_striping']) {
        $setting_classes[] = 'table-striped';
      }
      if ($this->settings['table_bordered']) {
        $setting_classes[] = 'table-bordered';
      }
      if ($this->settings['table_row_hover']) {
        $setting_classes[] = 'table-hover';
      }
      if ($this->settings['table_small']) {
        $setting_classes[] = 'table-sm';
      }
      $dom = Html::load($text);
      $xpath = new \DOMXPath($dom);
      $table_elements = $xpath
        ->query('//table');
      if (!is_null($table_elements)) {
        foreach ($table_elements as $element) {
          $existing_classes = [];
          $with_setting_classes = [];
          if ($element
            ->getAttribute('class')) {
            $existing_classes[] = $element
              ->getAttribute('class');
          }
          $with_setting_classes = array_unique(array_merge($existing_classes, $setting_classes), SORT_REGULAR);
          $all_classes = implode(' ', $with_setting_classes);
          $element
            ->setAttribute('class', $all_classes);
        }
      }
      if ($this->settings['table_remove_width_height']) {
        $tbody_elements = $xpath
          ->query('//tbody');
        if (!is_null($tbody_elements)) {
          foreach ($tbody_elements as $element) {
            $element
              ->removeAttribute('width');
            $element
              ->removeAttribute('height');
          }
        }
      }
      $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.
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.
TableFilter::process public function Performs the filter processing. Overrides FilterInterface::process
TableFilter::settingsForm public function Generates a filter's settings form. Overrides FilterBase::settingsForm