class FilterTips in Express 8

Pre-processes variables for the "filter_tips" theme hook.

Plugin annotation

@BootstrapPreprocess("filter_tips",
  replace = "template_preprocess_filter_tips"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\bootstrap\Plugin\PluginBase
      • class \Drupal\bootstrap\Plugin\Preprocess\PreprocessBase implements PreprocessInterface
        • class \Drupal\bootstrap\Plugin\Preprocess\FilterTips implements PreprocessInterface

File

themes/contrib/bootstrap/src/Plugin/Preprocess/FilterTips.php, line 22

Contains \Drupal\bootstrap\Plugin\Preprocess\FilterTips.

Namespace

Drupal\bootstrap\Plugin\Preprocess

class FilterTips extends PreprocessBase implements PreprocessInterface {

  /**
   * {@inheritdoc}
   */
  public function preprocessVariables(Variables $variables) {

    /** @var \Drupal\filter\FilterFormatInterface $current_format */
    $current_format = \Drupal::routeMatch()
      ->getParameter('filter_format');
    $current_format_id = $current_format ? $current_format
      ->id() : FALSE;

    // Create a place holder for the tabs.
    $build['tabs'] = [
      '#theme' => 'item_list__filter_tips__tabs',
      '#items' => [],
      '#attributes' => [
        'class' => [
          'nav',
          'nav-tabs',
          'filter-formats',
        ],
        'role' => 'tablist',
      ],
    ];

    // Create a placeholder for the panes.
    $build['panes'] = [
      '#theme_wrappers' => [
        'container__filter_tips__panes',
      ],
      '#attributes' => [
        'class' => [
          'tab-content',
        ],
      ],
    ];
    foreach (filter_formats(\Drupal::currentUser()) as $format_id => $format) {

      // Set the current format ID to the first format.
      if (!$current_format_id) {
        $current_format_id = $format_id;
      }
      $tab = [
        '#type' => 'link',
        '#title' => $format
          ->label(),
        '#url' => Url::fromRoute('filter.tips', [
          'filter_format' => $format_id,
        ]),
        '#attributes' => [
          'role' => 'tab',
          'data-toggle' => 'tab',
          'data-target' => "#{$format_id}",
        ],
      ];
      if ($current_format_id === $format_id) {
        $tab['#wrapper_attributes']['class'][] = 'active';
      }
      $build['tabs']['#items'][] = $tab;
      $tips = [];

      // Iterate over each format's enabled filters.

      /** @var \Drupal\filter\Plugin\FilterBase $filter */
      foreach ($format
        ->filters() as $name => $filter) {

        // Ignore filters that are not enabled.
        if (!$filter->status) {
          continue;
        }
        $tip = $filter
          ->tips(TRUE);
        if (isset($tip)) {
          $tips[] = [
            '#markup' => $tip,
          ];
        }
      }

      // Construct the pane.
      $pane = [
        '#theme_wrappers' => [
          'container__filter_tips',
        ],
        '#attributes' => [
          'class' => [
            'tab-pane',
            'fade',
          ],
          'id' => $format_id,
        ],
        'list' => [
          '#theme' => 'item_list',
          '#items' => $tips,
        ],
      ];
      if ($current_format_id === $format_id) {
        $pane['#attributes']['class'][] = 'active';
        $pane['#attributes']['class'][] = 'in';
      }
      $build['panes'][] = $pane;
    }
    $variables['tips'] = $build;
  }

}

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
FilterTips::preprocessVariables	public	function	Preprocess the variables array. Overrides PreprocessBase::preprocessVariables
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::$theme	protected	property	The currently set theme object.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
PreprocessBase::$hook	protected	property	The theme hook invoked.
PreprocessBase::$info	protected	property	The theme hook info array from the theme registry.
PreprocessBase::$variables	protected	property	The Variables object.
PreprocessBase::preprocess	public	function	Preprocess theme hook variables. Overrides PreprocessInterface::preprocess
PreprocessBase::preprocessAttributes	protected	function	Ensures all attributes have been converted to an Attribute object.
PreprocessBase::preprocessDescription	protected	function	Converts any set description variable into a traversable array.
PreprocessBase::preprocessElement	protected	function	Preprocess the variables array if an element is present.	8
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.