You are here

public function FilterResponsiveTable::tips in Responsive Table Filter 8

Generates a filter's tip.

A filter's tips should be informative and to the point. Short tips are preferably one-liners.

@todo Split into getSummaryItem() and buildGuidelines().

Parameters

bool $long: Whether this callback should return a short tip to display in a form (FALSE), or whether a more elaborate filter tips should be returned for template_preprocess_filter_tips() (TRUE).

Return value

string|null Translated text to display as a tip, or NULL if this filter has no tip.

Overrides FilterBase::tips

File

src/Plugin/Filter/FilterResponsiveTable.php, line 65
Contains \Drupal\responsive_table_filter\Plugin\Filter\FilterResponsiveTable.

Class

FilterResponsiveTable
Provides a filter that wraps <table> tags with a <figure> tag.

Namespace

Drupal\responsive_table_filter\Plugin\Filter

Code

public function tips($long = FALSE, $context = []) {
  return $this
    ->t('Wraps a %table tags with a %figure tag.', [
    '%table' => '<table>',
    '%figure' => '<' . $this
      ->getWrapperElement() . '>',
  ]);
}