class ViewsDisplay
Same name in this branch
- 11.x core/modules/views/src/Annotation/ViewsDisplay.php \Drupal\views\Annotation\ViewsDisplay
Same name in other branches
- 9 core/modules/views/src/Annotation/ViewsDisplay.php \Drupal\views\Annotation\ViewsDisplay
- 8.9.x core/modules/views/src/Annotation/ViewsDisplay.php \Drupal\views\Annotation\ViewsDisplay
- 10 core/modules/views/src/Annotation/ViewsDisplay.php \Drupal\views\Annotation\ViewsDisplay
- 10 core/modules/views/src/Attribute/ViewsDisplay.php \Drupal\views\Attribute\ViewsDisplay
Defines a Plugin attribute object for views display plugins.
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\ViewsDisplay extends \Drupal\Component\Plugin\Attribute\Plugin
- class \Drupal\Component\Plugin\Attribute\Plugin extends \Drupal\Component\Plugin\Attribute\AttributeBase
Expanded class hierarchy of ViewsDisplay
See also
\Drupal\views\Plugin\views\display\DisplayPluginBase
Related topics
10 files declare their use of ViewsDisplay
- Attachment.php in core/
modules/ views/ src/ Plugin/ views/ display/ Attachment.php - Block.php in core/
modules/ views/ src/ Plugin/ views/ display/ Block.php - DefaultDisplay.php in core/
modules/ views/ src/ Plugin/ views/ display/ DefaultDisplay.php - DisplayNoAreaTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ display/ DisplayNoAreaTest.php - DisplayTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ display/ DisplayTest.php
File
-
core/
modules/ views/ src/ Attribute/ ViewsDisplay.php, line 17
Namespace
Drupal\views\AttributeView source
class ViewsDisplay extends Plugin {
/**
* Constructs a views display attribute object.
*
* @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 $admin
* (optional) The administrative name of the display.
* The name is displayed on the Views overview and also used as default name
* for new displays.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help
* (optional) A short help string; this is displayed in the views UI.
* @param bool $uses_menu_links
* (optional) Whether or not to use hook_menu() to register a route.
* Defaults to FALSE.
* @param bool $uses_route
* (optional) Does the display plugin registers routes to the route.
* Defaults to FALSE.
* @param bool $uses_hook_block
* (optional) Does the display plugin provide blocks. Defaults to FALSE.
* @param bool $returns_response
* (optional) Whether the display returns a response object.
* Defaults to FALSE.
* @param string[]|null $contextual_links_locations
* (optional) A list of places where contextual links should be added.
* If you don't specify it there will be contextual links rendered for all
* displays of a view. If this is not set or regions have been specified,
* views will display an option to 'hide contextual links'. Use an empty
* array to disable.
* @param string[] $base
* (optional) The base tables on which this exposed form plugin can be used.
* If no base table is specified the plugin can be used with all tables.
* @param string|null $theme
* (optional) The theme function used to render the style output.
* @param bool $no_ui
* (optional) Whether the plugin should be not selectable in the UI.
* If it's set to TRUE, you can still use it via the API in config files.
* Defaults to FALSE.
* @param bool $register_theme
* (optional) Whether to register a theme function automatically. Defaults
* to TRUE.
* @param bool $entity_reference_display
* (optional) Custom property, used with \Drupal\views\Views::getApplicableViews().
* Defaults to FALSE.
* @param class-string|null $deriver
* (optional) The deriver class.
*/
public function __construct(string $id, TranslatableMarkup $title, ?TranslatableMarkup $short_title = NULL, ?TranslatableMarkup $admin = NULL, ?TranslatableMarkup $help = NULL, bool $uses_menu_links = FALSE, bool $uses_route = FALSE, bool $uses_hook_block = FALSE, bool $returns_response = FALSE, ?array $contextual_links_locations = NULL, array $base = [], ?string $theme = NULL, bool $no_ui = FALSE, bool $register_theme = TRUE, bool $entity_reference_display = FALSE, ?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 | Overrides AttributeInterface::get | 6 | |
AttributeBase::getClass | public | function | Overrides AttributeInterface::getClass | 1 | |
AttributeBase::getId | public | function | Overrides AttributeInterface::getId | ||
AttributeBase::getProvider | public | function | Overrides AttributeInterface::getProvider | ||
AttributeBase::setClass | public | function | Overrides AttributeInterface::setClass | 1 | |
AttributeBase::setProvider | public | function | Overrides AttributeInterface::setProvider | ||
ViewsDisplay::__construct | public | function | Constructs a views display attribute object. | Overrides Plugin::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.