class ViewsPager
Same name in this branch
- 11.x core/modules/views/src/Annotation/ViewsPager.php \Drupal\views\Annotation\ViewsPager
Same name in other branches
- 9 core/modules/views/src/Annotation/ViewsPager.php \Drupal\views\Annotation\ViewsPager
- 8.9.x core/modules/views/src/Annotation/ViewsPager.php \Drupal\views\Annotation\ViewsPager
- 10 core/modules/views/src/Annotation/ViewsPager.php \Drupal\views\Annotation\ViewsPager
- 10 core/modules/views/src/Attribute/ViewsPager.php \Drupal\views\Attribute\ViewsPager
Defines a views pager plugins type attribute for plugin discovery.
Hierarchy
- class \Drupal\Component\Plugin\Attribute\AttributeBase implements \Drupal\Component\Plugin\Attribute\AttributeInterface
- class \Drupal\Component\Plugin\Attribute\Plugin extends \Drupal\Component\Plugin\Attribute\AttributeBase
- class \Drupal\views\Attribute\ViewsPager extends \Drupal\Component\Plugin\Attribute\Plugin
- class \Drupal\Component\Plugin\Attribute\Plugin extends \Drupal\Component\Plugin\Attribute\AttributeBase
Expanded class hierarchy of ViewsPager
See also
\Drupal\views\Plugin\views\pager\PagerPluginBase
Related topics
4 files declare their use of ViewsPager
File
-
core/
modules/ views/ src/ Attribute/ ViewsPager.php, line 15
Namespace
Drupal\views\AttributeView source
class ViewsPager extends Plugin {
/**
* Constructs a ViewsPager attribute.
*
* @param string $id
* The plugin ID.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup $title
* The plugin title used in the views UI.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title
* (optional) The short title used in the views UI.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help
* (optional) A short help string; this is displayed in the views UI.
* @param string|null $theme
* (optional) The theme function used to render the pager's output.
* @param string[]|null $display_types
* (optional) The types of the display this plugin can be used with.
* For example the Feed display defines the type 'feed', so only rss style
* and row plugins can be used in the views UI.
* @param string[] $base
* (optional) The base tables on which this access plugin can be used.
* If no base table is specified the plugin can be used with all tables.
* @param bool $no_ui
* (optional) Whether the plugin should be not selectable in the UI.
* If set to TRUE, you can still use it via the API in config files.
* Defaults to FALSE.
* @param bool $register_theme
* (optional) Whether or not to register a theme function automatically.
* @param class-string|null $deriver
* (optional) The deriver class.
*/
public function __construct(string $id, TranslatableMarkup $title, ?TranslatableMarkup $short_title = NULL, ?TranslatableMarkup $help = NULL, ?string $theme = NULL, ?array $display_types = NULL, array $base = [], bool $no_ui = FALSE, bool $register_theme = TRUE, ?string $deriver = NULL) {
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AttributeBase::$class | protected | property | The class used for this attribute class. | ||
AttributeBase::$provider | protected | property | The provider of the attribute class. | ||
AttributeBase::get | public | function | Gets the value of an attribute. | Overrides AttributeInterface::get | 6 |
AttributeBase::getClass | public | function | Gets the class of the attribute class. | Overrides AttributeInterface::getClass | 1 |
AttributeBase::getId | public | function | Gets the unique ID for this attribute class. | Overrides AttributeInterface::getId | |
AttributeBase::getProvider | public | function | Gets the name of the provider of the attribute class. | Overrides AttributeInterface::getProvider | |
AttributeBase::setClass | public | function | Sets the class of the attributed class. | Overrides AttributeInterface::setClass | 1 |
AttributeBase::setProvider | public | function | Sets the name of the provider of the attribute class. | Overrides AttributeInterface::setProvider | |
ViewsPager::__construct | public | function | Constructs a ViewsPager attribute. | Overrides Plugin::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.