You are here

Home » API reference » Responsive Tables Filter 8 » FilterResponsiveTablesFilter.php

class FilterResponsiveTablesFilter in Responsive Tables Filter 8

Responsive Tables Filter class. Implements process() method only.

Plugin annotation


@Filter(
  id = "filter_responsive_tables_filter",
  title = @Translation("Apply responsive behavior to HTML tables."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE,
  settings = {
    "tablesaw_type" = "stack",
    "tablesaw_persist" = TRUE
  }
)

Hierarchy

Expanded class hierarchy of FilterResponsiveTablesFilter

1 file declares its use of FilterResponsiveTablesFilter
TablesawSettings.php in src/Form/TablesawSettings.php

File

src/Plugin/Filter/FilterResponsiveTablesFilter.php, line 22

Namespace

Drupal\responsive_tables_filter\Plugin\Filter
View source 
class FilterResponsiveTablesFilter extends FilterBase {

  /**
   * Available Tablesaw modes.
   *
   * @var modes
   */
  public static $modes = [
    'stack' => "Stack Mode",
    'columntoggle' => "Column Toggle Mode",
    'swipe' => "Swipe Mode",
  ];

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    if ($filtered = $this
      ->runFilter($text)) {
      $result = new FilterProcessResult($filtered);

      // Attach Tablesaw library assets to this page.
      $result
        ->setAttachments([
        'library' => [
          'responsive_tables_filter/tablesaw-filter',
        ],
      ]);
    }
    else {
      $result = new FilterProcessResult($text);
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['tablesaw_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default mode'),
      '#default_value' => $this->settings['tablesaw_type'] ?? 'stack',
      '#description' => $this
        ->t('This will apply by default to tables in WYSIWYGs, but can be overridden on an individual basis by adding the <code>class</code> "tablesaw-stack", "tablesaw-columntoggle", or "tablesaw-swipe" to the <code>table</code> tag. See documentation: https://github.com/filamentgroup/tablesaw'),
      '#options' => self::$modes,
    ];
    $form['tablesaw_persist'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Persistent first column?'),
      '#default_value' => $this->settings['tablesaw_persist'] ?? TRUE,
      '#description' => $this
        ->t('This will apply to all tables in WYSIWYGs.'),
    ];
    return $form;
  }

  /**
   * Business logic for adding classes & attributes to <table> tags.
   */
  public function runFilter($text) {

    // Older versions of libxml always add DOCTYPE, <html>, and <body> tags.
    // See http://www.php.net/manual/en/libxml.constants.php.
    // Sometimes, PHP is >= 5.4, but libxml is old enough that the constants are
    // not defined.
    static $new_libxml;
    if (!isset($new_libxml)) {
      $new_libxml = version_compare(PHP_VERSION, '5.4', '>=') && defined('LIBXML_HTML_NOIMPLIED') && defined('LIBXML_HTML_NODEFDTD');
    }
    if ($text != '') {
      $tables = [];
      libxml_use_internal_errors(TRUE);

      // LibXML requires that the html is wrapped in a root node.
      $text = '<root>' . $text . '</root>';
      $dom = new \DOMDocument();
      if ($new_libxml) {
        $dom
          ->loadHTML(mb_convert_encoding($text, 'HTML-ENTITIES', 'UTF-8'), LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
      }
      else {
        $dom
          ->loadHTML(mb_convert_encoding($text, 'HTML-ENTITIES', 'UTF-8'));
      }
      $tables = $dom
        ->getElementsByTagName('table');

      // Find all tables in text.
      if ($tables->length !== 0) {
        foreach ($tables as $table) {

          // Find existing class attributes, if any, and append tablesaw class.
          $existing_classes = $table
            ->getAttribute('class');
          if (strpos($existing_classes, 'no-tablesaw') === FALSE) {
            $mode = $this->settings['tablesaw_type'] ?? 'stack';

            // Allow for class-based override of default.
            foreach (array_keys(self::$modes) as $mode_option) {
              if (strpos($existing_classes, "tablesaw-" . $mode_option) !== FALSE) {
                $mode = $mode_option;
                break;
              }
            }
            $new_classes = !empty($existing_classes) ? $existing_classes . ' tablesaw tablesaw-' . $mode : 'tablesaw tablesaw-' . $mode;
            $table
              ->setAttribute('class', $new_classes);

            // Set data-tablesaw-mode & minimap.
            $table
              ->setAttribute('data-tablesaw-mode', $mode);
            $table
              ->setAttribute('data-tablesaw-minimap', NULL);
            $persist = $this->settings['tablesaw_persist'] ?? TRUE;
            $ths = $table
              ->getElementsByTagName('th');
            $inc = 1;
            foreach ($ths as $delta => $th) {

              // Add required columntoggle- & swipe- specific attributes.
              if (in_array($mode, [
                'columntoggle',
                'swipe',
              ])) {
                $th
                  ->setAttribute('data-tablesaw-sortable-col', '');
                if (!$th
                  ->getAttribute('data-tablesaw-priority')) {
                  $th
                    ->setAttribute('data-tablesaw-priority', $inc);
                  $inc++;
                }
              }

              // Add persistent first column if no priority has been specified.
              if ($persist && $delta === 0 && !$th
                ->getAttribute('data-tablesaw-priority')) {
                $th
                  ->setAttribute('data-tablesaw-priority', 'persist');
              }
            }
          }
        }

        // Get innerHTML of root node.
        $html = "";
        foreach ($dom
          ->getElementsByTagName('root')
          ->item(0)->childNodes as $child) {

          // Re-serialize the HTML.
          $html .= $dom
            ->saveHTML($child);
        }

        // For lower older libxml, use preg_replace to clean up DOCTYPE.
        if (!$new_libxml) {
          $html_start = strpos($html, '<html><body>') + 12;
          $html_length = strpos($html, '</body></html>') - $html_start;
          $html = substr($html, $html_start, $html_length);
        }
        return $html;
      }
    }
    return FALSE;
  }

}

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.
FilterResponsiveTablesFilter::$modes public static property Available Tablesaw modes.
FilterResponsiveTablesFilter::process public function Performs the filter processing. Overrides FilterInterface::process
FilterResponsiveTablesFilter::runFilter public function Business logic for adding classes & attributes to <table> tags.
FilterResponsiveTablesFilter::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.