class AlphaPaginationArea in Views Alpha Pagination 8.2

Views area handler to display alphabetic pagination.

Plugin annotation

@ViewsArea("alpha_pagination");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
    class \Drupal\views\Plugin\views\area\AreaPluginBase
    class \Drupal\alpha_pagination\Plugin\views\area\AlphaPaginationArea

Expanded class hierarchy of AlphaPaginationArea

1 file declares its use of AlphaPaginationArea

AlphaPagination.php in src/AlphaPagination.php

File

src/Plugin/views/area/AlphaPaginationArea.php, line 20

Namespace

Drupal\alpha_pagination\Plugin\views\area

View source

class AlphaPaginationArea extends AreaPluginBase {

  /**
   * The AlphaPagination object reference.
   *
   * @var \Drupal\alpha_pagination\AlphaPagination
   */
  protected $alphaPagination;

  /**
   * The Entity Field Manager Interface.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $fieldManager;

  /**
   * The cache backend service.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheBackend;

  /**
   * Constructs a new RenderedEntity object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \alpha_pagination\AlphaPagination $alpha_pagination
   *   The Alpha Pagination service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $field_manager
   *   The EntityField Manager.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend service.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, AlphaPagination $alpha_pagination, EntityFieldManagerInterface $field_manager, CacheBackendInterface $cache_backend) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->alphaPagination = $alpha_pagination;
    $this->alphaPagination
      ->setHandler($this);
    $this->fieldManager = $field_manager;
    $this->cacheBackend = $cache_backend;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('alpha_pagination'), $container
      ->get('entity_field.manager'), $container
      ->get('cache.default'));
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return '';
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();

    // Global.
    $options['paginate_view_relationship'] = [
      'default' => 'none',
      'translatable' => TRUE,
    ];
    $options['paginate_view_field'] = [
      'default' => 'title',
      'translatable' => TRUE,
    ];

    // Link.
    $options['paginate_link_path'] = [
      'default' => '[alpha_pagination:path]/[alpha_pagination:value]',
      'translatable' => FALSE,
    ];
    $options['paginate_link_external'] = [
      'default' => 0,
      'translatable' => FALSE,
    ];
    $options['paginate_link_class'] = [
      'default' => '',
      'translatable' => FALSE,
    ];
    $options['paginate_link_attributes'] = [
      'default' => '',
      'translatable' => FALSE,
    ];

    // Classes.
    $options['paginate_class'] = [
      'default' => 'alpha-pagination',
      'translatable' => FALSE,
    ];
    $options['paginate_list_class'] = [
      'default' => 'alpha-pagination-list',
      'translatable' => FALSE,
    ];
    $options['paginate_active_class'] = [
      'default' => 'active',
      'translatable' => FALSE,
    ];
    $options['paginate_inactive_class'] = [
      'default' => 'inactive',
      'translatable' => FALSE,
    ];

    // All.
    $options['paginate_all_display'] = [
      'default' => 1,
      'translatable' => FALSE,
    ];
    $options['paginate_all_class'] = [
      'default' => 'all',
      'translatable' => FALSE,
    ];
    $options['paginate_all_label'] = [
      'default' => t('All'),
      'translatable' => TRUE,
    ];
    $options['paginate_all_value'] = [
      'default' => 'all',
      'translatable' => FALSE,
    ];
    $options['paginate_all_position'] = [
      'default' => 'after',
      'translatable' => FALSE,
    ];
    $options['paginate_toggle_empty'] = [
      'default' => 1,
      'translatable' => FALSE,
    ];

    // Numeric.
    $options['paginate_view_numbers'] = [
      'default' => 0,
      'translatable' => FALSE,
    ];
    $options['paginate_numeric_class'] = [
      'default' => 'numeric',
      'translatable' => FALSE,
    ];
    $options['paginate_numeric_divider'] = [
      'default' => 1,
      'translatable' => FALSE,
    ];
    $options['paginate_numeric_divider_class'] = [
      'default' => '-',
      'translatable' => FALSE,
    ];
    $options['paginate_numeric_hide_empty'] = [
      'default' => 1,
      'translatable' => FALSE,
    ];
    $options['paginate_numeric_label'] = [
      'default' => '#',
      'translatable' => FALSE,
    ];
    $options['paginate_numeric_position'] = [
      'default' => 'before',
      'translatable' => FALSE,
    ];
    $options['paginate_numeric_value'] = [
      'default' => implode('+', $this->alphaPagination
        ->getNumbers()),
      'translatable' => FALSE,
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {

    // Need to clear cache when options have changed.
    $this->cacheBackend
      ->invalidate($this->alphaPagination
      ->getCid());
    $options = $form_state
      ->getValue('options');

    // Filter attributes for any XSS vulnerabilities before saving.
    if (!empty($options['paginate_link_attributes'])) {
      $form_state
        ->setValue([
        'options',
        'paginate_link_attributes',
      ], Xss::filterAdmin($options['paginate_link_attributes']));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);

    // Hide unnecessary label.
    $form['label']['#access'] = FALSE;

    // Global options.
    $base_table = $this->view->storage
      ->get('base_table');
    if ($base_table == 'taxonomy_term_data' || $base_table == 'media_field_data') {

      // Get an array list of all non-image, non-entity or other assorted
      // reference fields.
      $fields = [
        'name' => 'name',
      ];
    }
    else {

      // Get an array list of all non-image, non-entity or other assorted
      // reference fields.
      $fields = [
        'title' => 'title',
      ];
    }
    $compound_field_types = [
      'name',
    ];
    $single_field_types = [
      'text',
      'text_long',
      'text_with_summary',
      'string',
      'string_long',
    ];
    $all_field_types = array_merge($single_field_types, $compound_field_types);
    $all_fields = $this->fieldManager
      ->getFieldMap();
    $baseEntityType = $this->view
      ->getBaseEntityType()
      ->id();
    foreach ($all_fields[$baseEntityType] as $field_name => $field_definition) {
      if (in_array($field_definition['type'], $all_field_types)) {
        if (in_array($field_definition['type'], $compound_field_types)) {
          $field_info = FieldStorageConfig::loadByName('node', $field_name);
          $field_info = field_info_field($field_name);
          foreach (array_keys($field_info['columns']) as $compoundFieldKey) {
            $compound_field_field_name = sprintf('%s:%s', $field_name, $compoundFieldKey);
            $fields[$baseEntityType . '__' . $compound_field_field_name] = $compound_field_field_name;
          }
        }
        else {
          $fields[$baseEntityType . '__' . $field_name] = $field_name;
        }
      }
    }
    $relationship_options = [];
    foreach ($this->view->display_handler
      ->getHandlers('relationship') as $id => $handler) {

      // Ignore invalid/broken relationships.
      if (empty($handler)) {
        continue;
      }
      $relationship_options[$id] = $handler
        ->adminLabel();
    }
    if (count($relationship_options) > 0) {
      $relationship_options = array_merge([
        'none' => $this
          ->t('Do not use a relationship'),
      ], $relationship_options);
      $form['paginate_view_relationship'] = [
        '#title' => t('Relationship'),
        '#type' => 'select',
        '#options' => $relationship_options,
        '#default_value' => $this->alphaPagination
          ->getOption('paginate_view_relationship'),
      ];
    }
    $form['paginate_view_field'] = [
      '#title' => t('View field to paginate against'),
      '#type' => 'select',
      '#options' => $fields,
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_view_field'),
      '#description' => t('This will be the content field that drives the pagination.'),
    ];
    $form['paginate_toggle_empty'] = [
      '#type' => 'checkbox',
      '#title' => t('Show options without results'),
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_toggle_empty'),
      '#description' => t('Show or hide letters without results'),
    ];

    // Link.
    $form['paginate_link'] = [
      '#type' => 'details',
      '#title' => t('Link'),
      '#collapsible' => TRUE,
    ];
    $form['paginate_link_path'] = [
      '#title' => t('Path'),
      '#type' => 'textfield',
      '#size' => 60,
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_link_path'),
      '#description' => t('This is the path the link will be rendered with. No beginning or ending slashes.'),
      '#fieldset' => 'paginate_link',
    ];
    $form['paginate_link_external'] = [
      '#type' => 'checkbox',
      '#title' => t('External'),
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_link_external'),
      '#description' => t('Indicates whether this is an external link (not processed). If the above path starts with a hash symbol (#), then this option will automatically enable so it can render as a relative link to an anchor on the current page.'),
      '#fieldset' => 'paginate_link',
    ];
    $form['paginate_link_class'] = [
      '#title' => t('Classes'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_link_class'),
      '#description' => t('CSS classes for the link, separated by spaces.'),
      '#fieldset' => 'paginate_link',
    ];
    $form['paginate_link_attributes'] = [
      '#type' => 'textfield',
      '#title' => t('Attributes'),
      '#description' => 'E.g. id|custom-id,role|navigation,data-key|value',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_link_attributes'),
      '#fieldset' => 'paginate_link',
    ];
    $form['paginate_link_tokens'] = $this->alphaPagination
      ->buildTokenTree('paginate_link');

    // Class options.
    $form['paginate_classes'] = [
      '#type' => 'details',
      '#title' => t('Classes'),
      '#description' => t('Provide additional CSS classes on elements in the pagination; separated by spaces.'),
      '#collapsible' => TRUE,
    ];
    $form['paginate_class'] = [
      '#title' => t('Wrapper'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_class'),
      '#description' => t('The wrapper around the item list.'),
      '#fieldset' => 'paginate_classes',
    ];
    $form['paginate_list_class'] = [
      '#title' => t('Item List'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_list_class'),
      '#description' => t('The item list.'),
      '#fieldset' => 'paginate_classes',
    ];
    $form['paginate_active_class'] = [
      '#title' => t('Active item'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_active_class'),
      '#description' => t('The active list item.'),
      '#fieldset' => 'paginate_classes',
    ];
    $form['paginate_inactive_class'] = [
      '#title' => t('Inactive item'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_inactive_class'),
      '#description' => t('The inactive list item(s) that are not links, a.k.a. "no results".'),
      '#fieldset' => 'paginate_classes',
    ];

    // "All" options.
    $form['paginate_all_options'] = [
      '#type' => 'details',
      '#title' => t('"All" item'),
      '#collapsible' => TRUE,
    ];
    $form['paginate_all_display'] = [
      '#type' => 'select',
      '#title' => t('Display the "All" item'),
      '#options' => [
        0 => t('No'),
        1 => t('Yes'),
      ],
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_all_display'),
      '#description' => t('Displays the "All" link in the pagination.'),
      '#fieldset' => 'paginate_all_options',
    ];
    $form['paginate_all_position'] = [
      '#type' => 'select',
      '#title' => t('Position'),
      '#options' => [
        'before' => t('Before'),
        'after' => t('After'),
      ],
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_all_position'),
      '#description' => t('Determines where the "All" item will show up in the pagination.'),
      '#fieldset' => 'paginate_all_options',
      '#states' => [
        'visible' => [
          [
            ':input[name="options[paginate_all_display]"]' => [
              'value' => 1,
            ],
          ],
        ],
      ],
    ];
    $form['paginate_all_label'] = [
      '#type' => 'textfield',
      '#title' => t('Label'),
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_all_label'),
      '#description' => t('The label to use for display the "All" item in the pagination.'),
      '#fieldset' => 'paginate_all_options',
      '#states' => [
        'visible' => [
          [
            ':input[name="options[paginate_all_display]"]' => [
              'value' => 1,
            ],
          ],
        ],
      ],
    ];
    $form['paginate_all_value'] = [
      '#type' => 'textfield',
      '#title' => t('Value'),
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_all_value'),
      '#description' => t('The value to use to represent all items.'),
      '#fieldset' => 'paginate_all_options',
      '#states' => [
        'visible' => [
          [
            ':input[name="options[paginate_all_display]"]' => [
              'value' => 1,
            ],
          ],
        ],
      ],
    ];
    $form['paginate_all_class'] = [
      '#title' => t('Classes'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_all_class'),
      '#description' => t('CSS classes for "All" item (on <code>&lt;li&gt;</code> element); separated by spaces.'),
      '#fieldset' => 'paginate_all_options',
      '#states' => [
        'visible' => [
          [
            ':input[name="options[paginate_all_display]"]' => [
              'value' => 1,
            ],
          ],
        ],
      ],
    ];

    // "Numeric" options.
    $form['paginate_numeric_options'] = [
      '#type' => 'details',
      '#title' => t('Numeric items'),
      '#collapsible' => TRUE,
    ];
    $form['paginate_view_numbers'] = [
      '#title' => t('Display numeric items'),
      '#type' => 'select',
      '#options' => [
        0 => t('No'),
        1 => t('Individual numbers (0-9)'),
        2 => t('Single label (#)'),
      ],
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_view_numbers'),
      '#description' => t('Displays numeric item(s) in the pagination.'),
      '#fieldset' => 'paginate_numeric_options',
    ];

    // Global numeric options.
    $form['paginate_numeric_class'] = [
      '#title' => t('Classes'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_numeric_class'),
      '#description' => t('CSS classes for numeric item (on <code>&lt;li&gt;</code> element); separated by spaces.'),
      '#fieldset' => 'paginate_numeric_options',
      '#states' => [
        'visible' => [
          [
            ':input[name="options[paginate_view_numbers]"]' => [
              'value' => 1,
            ],
          ],
          'or',
          [
            ':input[name="options[paginate_view_numbers]"]' => [
              'value' => 2,
            ],
          ],
        ],
      ],
    ];
    $form['paginate_numeric_position'] = [
      '#type' => 'select',
      '#title' => t('Position'),
      '#options' => [
        'before' => t('Before'),
        'after' => t('After'),
      ],
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_numeric_position'),
      '#description' => t('Determines whether numeric items are shown before or after alphabetical links in the pagination.'),
      '#fieldset' => 'paginate_numeric_options',
      '#states' => [
        'visible' => [
          [
            ':input[name="options[paginate_view_numbers]"]' => [
              'value' => 1,
            ],
          ],
          'or',
          [
            ':input[name="options[paginate_view_numbers]"]' => [
              'value' => 2,
            ],
          ],
        ],
      ],
    ];
    $form['paginate_numeric_hide_empty'] = [
      '#title' => t('Hide all numeric item(s) if empty'),
      '#description' => t('Will not render any numeric item(s) if there are no results that start with numeric values.'),
      '#type' => 'checkbox',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_numeric_hide_empty'),
      '#fieldset' => 'paginate_numeric_options',
      '#states' => [
        'visible' => [
          [
            ':input[name="options[paginate_view_numbers]"]' => [
              'value' => 1,
            ],
          ],
          'or',
          [
            ':input[name="options[paginate_view_numbers]"]' => [
              'value' => 2,
            ],
          ],
        ],
      ],
    ];

    // Individual numeric items.
    $form['paginate_numeric_divider'] = [
      '#type' => 'checkbox',
      '#title' => t('Show divider'),
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_numeric_divider'),
      '#description' => t('Will render a specific divider item before or after the numeric items have been render, based on position.'),
      '#fieldset' => 'paginate_numeric_options',
      '#states' => [
        'visible' => [
          ':input[name="options[paginate_view_numbers]"]' => [
            'value' => 1,
          ],
        ],
      ],
    ];
    $form['paginate_numeric_divider_class'] = [
      '#title' => t('Divider Text'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_numeric_divider_class'),
      '#description' => t('Text to use to separate numeric options from alphabetic.'),
      '#fieldset' => 'paginate_numeric_options',
      '#states' => [
        'visible' => [
          ':input[name="options[paginate_view_numbers]"]' => [
            'value' => 1,
          ],
          ':input[name="options[paginate_numeric_divider]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Single numeric item.
    $form['paginate_numeric_label'] = [
      '#title' => t('Label'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_numeric_label'),
      '#description' => t('The label to use to represent all numeric values.'),
      '#fieldset' => 'paginate_numeric_options',
      '#states' => [
        'visible' => [
          ':input[name="options[paginate_view_numbers]"]' => [
            'value' => 2,
          ],
        ],
      ],
    ];
    $form['paginate_numeric_value'] = [
      '#title' => t('Value'),
      '#type' => 'textfield',
      '#default_value' => $this->alphaPagination
        ->getOption('paginate_numeric_value'),
      '#description' => t('The value to use to represent all numeric values (i.e. URL value).'),
      '#fieldset' => 'paginate_numeric_options',
      '#states' => [
        'visible' => [
          ':input[name="options[paginate_view_numbers]"]' => [
            'value' => 2,
          ],
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function postExecute(&$values) {
    $this->alphaPagination
      ->ensureQuery();
  }

  /**
   * Render the alphabetic pagination.
   *
   * @param bool $empty
   *   If this area should be empty, then return it as empty.
   *
   * @return string
   *   A string representing the complete pagination including linked and
   *   unlinked options.
   */
  public function render($empty = FALSE) {

    // Create the wrapper.
    $wrapper = [
      '#theme_wrappers' => [
        'container__alpha_pagination__wrapper',
      ],
      '#attributes' => [],
      '#attached' => [
        'library' => [
          'alpha_pagination/alpha_pagination',
        ],
      ],
    ];
    $this->alphaPagination
      ->addClasses($this->alphaPagination
      ->getOption('paginate_class'), $wrapper['#attributes']);

    // Iterate over the alphabet and populate the items for the item list.
    $items = [];
    foreach ($this->alphaPagination
      ->getCharacters() as $character) {

      // Add special numeric divider.
      if ($character
        ->getValue() === '-' && $this->alphaPagination
        ->getOption('paginate_view_numbers') !== '2' && $this->alphaPagination
        ->getOption('paginate_numeric_divider')) {

        // Add an empty list item.
        $item = [
          'data' => '',
        ];
        $this->alphaPagination
          ->addClasses($this->alphaPagination
          ->getOption('paginate_numeric_divider_class'), $item);
        $items[] = $item;
      }
      elseif ($item = $character
        ->build()) {
        $item['#wrapper_attributes'] = [];

        // Add the necessary classes for item.
        if ($character
          ->isAll()) {
          $this->alphaPagination
            ->addClasses($this->alphaPagination
            ->getOption('paginate_all_class'), $item['#wrapper_attributes']);
        }
        if ($character
          ->isNumeric()) {
          $this->alphaPagination
            ->addClasses($this->alphaPagination
            ->getOption('paginate_numeric_class'), $item['#wrapper_attributes']);
        }
        if ($character
          ->isActive()) {
          $this->alphaPagination
            ->addClasses($this->alphaPagination
            ->getOption('paginate_active_class'), $item['#wrapper_attributes']);
        }
        elseif (!$character
          ->isEnabled()) {
          $this->alphaPagination
            ->addClasses($this->alphaPagination
            ->getOption('paginate_inactive_class'), $item['#wrapper_attributes']);
        }

        // Add the constructed item to the list.
        $items[] = $item;
      }
    }

    // Sanitize any classes provided for the item list.
    $item_list = [
      '#theme' => 'item_list__alpha_pagination',
      '#attributes' => [],
      '#items' => $items,
    ];
    $this->alphaPagination
      ->addClasses($this->alphaPagination
      ->getOption('paginate_list_class'), $item_list['#attributes']);

    // Append the item list to the wrapper.
    $wrapper[] = $item_list;
    return $wrapper;
  }

  /**
   * {@inheritdoc}
   */
  public function validate() {
    return $this->alphaPagination
      ->validate();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AlphaPaginationArea::$alphaPagination	protected	property	The AlphaPagination object reference.
AlphaPaginationArea::$cacheBackend	protected	property	The cache backend service.
AlphaPaginationArea::$fieldManager	protected	property	The Entity Field Manager Interface.
AlphaPaginationArea::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides AreaPluginBase::buildOptionsForm
AlphaPaginationArea::create	public static	function	Creates an instance of the plugin. Overrides PluginBase::create
AlphaPaginationArea::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides AreaPluginBase::defineOptions
AlphaPaginationArea::label	public	function
AlphaPaginationArea::postExecute	public	function	Run after the view is executed, before the result is cached. Overrides HandlerBase::postExecute
AlphaPaginationArea::render	public	function	Render the alphabetic pagination. Overrides AreaPluginBase::render
AlphaPaginationArea::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides PluginBase::submitOptionsForm
AlphaPaginationArea::validate	public	function	Validate that the plugin is correct and can be saved. Overrides HandlerBase::validate
AlphaPaginationArea::__construct	public	function	Constructs a new RenderedEntity object. Overrides HandlerBase::__construct
AreaPluginBase::$areaType	public	property	The type of this area handler, i.e. 'header', 'footer', or 'empty'.
AreaPluginBase::adminSummary	public	function	Provide text for the administrative summary. Overrides HandlerBase::adminSummary
AreaPluginBase::init	public	function	Overrides Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase::init	1
AreaPluginBase::isEmpty	public	function	Does that area have nothing to show.	1
AreaPluginBase::preRender	public	function	Performs any operations needed before full rendering.	1
AreaPluginBase::usesGroupBy	public	function	Provides the handler some groupby. Overrides HandlerBase::usesGroupBy
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
HandlerBase::$field	public	property	With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler	protected	property	The module handler.	3
HandlerBase::$query	public	property	Where the $query object will reside:	7
HandlerBase::$realField	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$relationship	public	property	The relationship used for this field.
HandlerBase::$table	public	property	The table this handler is attached to.
HandlerBase::$tableAlias	public	property	The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData	protected	property	The views data service.
HandlerBase::acceptExposedInput	public	function	Take input from exposed handlers and assign to this handler, if necessary.	1
HandlerBase::access	public	function	Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access	4
HandlerBase::adminLabel	public	function	Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface::adminLabel	4
HandlerBase::breakString	public static	function	Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken	public	function	Determines if the handler is considered 'broken', meaning it's a placeholder used when a handler can't be found. Overrides ViewsHandlerInterface::broken
HandlerBase::buildExposedForm	public	function	Render our chunk of the exposed handler form when selecting	1
HandlerBase::buildExposeForm	public	function	Form for exposed handler options.	2
HandlerBase::buildExtraOptionsForm	public	function	Provide a form for setting options.	1
HandlerBase::buildGroupByForm	public	function	Provide a form for aggregation settings.	1
HandlerBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies	10
HandlerBase::canExpose	public	function	Determine if a handler can be exposed.	2
HandlerBase::caseTransform	protected	function	Transform a string by a certain method.
HandlerBase::defaultExposeOptions	public	function	Set new exposed option defaults when exposed setting is flipped on.	2
HandlerBase::defineExtraOptions	public	function	Provide defaults for the handler.
HandlerBase::displayExposedForm	public	function	Displays the Expose form.
HandlerBase::ensureMyTable	public	function	Ensure the main table for this handler is in the query. This is used a lot. Overrides ViewsHandlerInterface::ensureMyTable	2
HandlerBase::exposedInfo	public	function	Get information about the exposed form for the form renderer.	1
HandlerBase::getDateField	public	function	Creates cross-database SQL dates.	2
HandlerBase::getDateFormat	public	function	Creates cross-database SQL date formatting.	2
HandlerBase::getEntityType	public	function	Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField	public	function	Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin	public	function	Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler	protected	function	Gets the module handler.
HandlerBase::getTableJoin	public static	function	Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData	protected	function	Gets views data service.
HandlerBase::hasExtraOptions	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
HandlerBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.	1
HandlerBase::isExposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput	public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.	1
HandlerBase::placeholder	protected	function	Provides a unique placeholders for handlers.
HandlerBase::preQuery	public	function	Run before the view is built. Overrides ViewsHandlerInterface::preQuery	2
HandlerBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	7
HandlerBase::sanitizeValue	public	function	Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler	public	function	Sets the module handler.
HandlerBase::setRelationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData	public	function
HandlerBase::showExposeButton	public	function	Shortcut to display the expose/hide button.	2
HandlerBase::showExposeForm	public	function	Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::storeExposedInput	public	function	If set to remember exposed input in the session, store it there.	1
HandlerBase::submitExposed	public	function	Submit the exposed handler form
HandlerBase::submitExposeForm	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitFormCalculateOptions	public	function	Calculates options stored on the handler	1
HandlerBase::submitGroupByForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
HandlerBase::submitTemporaryForm	public	function	A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::validateExposed	public	function	Validate the exposed handler form	4
HandlerBase::validateExposeForm	public	function	Validate the options form.	1
HandlerBase::validateExtraOptionsForm	public	function	Validate the options form.
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::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form.	8
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function	Clears a plugin. Overrides ViewsPluginInterface::destroy	2
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks	6
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::validateOptionsForm	public	function	Validate the options form. Overrides ViewsPluginInterface::validateOptionsForm	15
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
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.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class AlphaPaginationArea in Views Alpha Pagination 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation