class Attachment
Same name in other branches
- 9 core/modules/views/src/Plugin/views/display/Attachment.php \Drupal\views\Plugin\views\display\Attachment
- 8.9.x core/modules/views/src/Plugin/views/display/Attachment.php \Drupal\views\Plugin\views\display\Attachment
- 11.x core/modules/views/src/Plugin/views/display/Attachment.php \Drupal\views\Plugin\views\display\Attachment
The plugin that handles an attachment display.
Attachment displays are secondary displays that are 'attached' to a primary display. Effectively they are a simple way to get multiple views within the same view. They can share some information.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\display\DisplayPluginBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\display\DisplayPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Plugin\PluginDependencyTrait
- class \Drupal\views\Plugin\views\display\Attachment extends \Drupal\views\Plugin\views\display\DisplayPluginBase
- class \Drupal\views\Plugin\views\display\DisplayPluginBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\display\DisplayPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Plugin\PluginDependencyTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Attachment
Related topics
18 string references to 'Attachment'
- Attachment::optionsSummary in core/
modules/ views/ src/ Plugin/ views/ display/ Attachment.php - Provide the summary for attachment options in the views UI.
- ExportForm::submitForm in core/
modules/ locale/ src/ Form/ ExportForm.php - Form submission handler.
- TableFormatter::viewElements in core/
modules/ file/ src/ Plugin/ Field/ FieldFormatter/ TableFormatter.php - Builds a renderable array for a field value.
- views.view.glossary.yml in core/
modules/ node/ config/ optional/ views.view.glossary.yml - core/modules/node/config/optional/views.view.glossary.yml
- views.view.glossary.yml in core/
modules/ node/ config/ optional/ views.view.glossary.yml - core/modules/node/config/optional/views.view.glossary.yml
File
-
core/
modules/ views/ src/ Plugin/ views/ display/ Attachment.php, line 19
Namespace
Drupal\views\Plugin\views\displayView source
class Attachment extends DisplayPluginBase {
/**
* Whether the display allows the use of a pager or not.
*
* @var bool
*/
protected $usesPager = FALSE;
protected function defineOptions() {
$options = parent::defineOptions();
$options['displays'] = [
'default' => [],
];
$options['attachment_position'] = [
'default' => 'before',
];
$options['inherit_arguments'] = [
'default' => TRUE,
];
$options['inherit_exposed_filters'] = [
'default' => FALSE,
];
$options['inherit_pager'] = [
'default' => FALSE,
];
$options['render_pager'] = [
'default' => FALSE,
];
return $options;
}
public function execute() {
return $this->view
->render($this->display['id']);
}
public function attachmentPositions($position = NULL) {
$positions = [
'before' => $this->t('Before'),
'after' => $this->t('After'),
'both' => $this->t('Both'),
];
if ($position) {
return $positions[$position];
}
return $positions;
}
/**
* Provide the summary for attachment options in the views UI.
*
* This output is returned as an array.
*/
public function optionsSummary(&$categories, &$options) {
// It is very important to call the parent function here:
parent::optionsSummary($categories, $options);
$categories['attachment'] = [
'title' => $this->t('Attachment settings'),
'column' => 'second',
'build' => [
'#weight' => -10,
],
];
$displays = array_filter($this->getOption('displays'));
if (count($displays) > 1) {
$attach_to = $this->t('Multiple displays');
}
elseif (count($displays) == 1) {
$display = array_shift($displays);
if ($display = $this->view->storage
->getDisplay($display)) {
$attach_to = $display['display_title'];
}
}
if (!isset($attach_to)) {
$attach_to = $this->t('Not defined');
}
$options['displays'] = [
'category' => 'attachment',
'title' => $this->t('Attach to'),
'value' => $attach_to,
];
$options['attachment_position'] = [
'category' => 'attachment',
'title' => $this->t('Attachment position'),
'value' => $this->attachmentPositions($this->getOption('attachment_position')),
];
$options['inherit_arguments'] = [
'category' => 'attachment',
'title' => $this->t('Inherit contextual filters'),
'value' => $this->getOption('inherit_arguments') ? $this->t('Yes') : $this->t('No'),
];
$options['inherit_exposed_filters'] = [
'category' => 'attachment',
'title' => $this->t('Inherit exposed filters'),
'value' => $this->getOption('inherit_exposed_filters') ? $this->t('Yes') : $this->t('No'),
];
$options['inherit_pager'] = [
'category' => 'pager',
'title' => $this->t('Inherit pager'),
'value' => $this->getOption('inherit_pager') ? $this->t('Yes') : $this->t('No'),
];
$options['render_pager'] = [
'category' => 'pager',
'title' => $this->t('Render pager'),
'value' => $this->getOption('render_pager') ? $this->t('Yes') : $this->t('No'),
];
}
/**
* Provide the default form for setting options.
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
// It is very important to call the parent function here:
parent::buildOptionsForm($form, $form_state);
switch ($form_state->get('section')) {
case 'inherit_arguments':
$form['#title'] .= $this->t('Inherit contextual filters');
$form['inherit_arguments'] = [
'#type' => 'checkbox',
'#title' => $this->t('Inherit'),
'#description' => $this->t('Should this display inherit its contextual filter values from the parent display to which it is attached?'),
'#default_value' => $this->getOption('inherit_arguments'),
];
break;
case 'inherit_exposed_filters':
$form['#title'] .= $this->t('Inherit exposed filters');
$form['inherit_exposed_filters'] = [
'#type' => 'checkbox',
'#title' => $this->t('Inherit'),
'#description' => $this->t('Should this display inherit its exposed filter values from the parent display to which it is attached?'),
'#default_value' => $this->getOption('inherit_exposed_filters'),
];
break;
case 'inherit_pager':
$form['#title'] .= $this->t('Inherit pager');
$form['inherit_pager'] = [
'#type' => 'checkbox',
'#title' => $this->t('Inherit'),
'#description' => $this->t('Should this display inherit its paging values from the parent display to which it is attached?'),
'#default_value' => $this->getOption('inherit_pager'),
];
break;
case 'render_pager':
$form['#title'] .= $this->t('Render pager');
$form['render_pager'] = [
'#type' => 'checkbox',
'#title' => $this->t('Render'),
'#description' => $this->t('Should this display render the pager values? This is only meaningful if inheriting a pager.'),
'#default_value' => $this->getOption('render_pager'),
];
break;
case 'attachment_position':
$form['#title'] .= $this->t('Position');
$form['attachment_position'] = [
'#title' => $this->t('Position'),
'#type' => 'radios',
'#description' => $this->t('Attach before or after the parent display?'),
'#options' => $this->attachmentPositions(),
'#default_value' => $this->getOption('attachment_position'),
];
break;
case 'displays':
$form['#title'] .= $this->t('Attach to');
$displays = [];
foreach ($this->view->storage
->get('display') as $display_id => $display) {
if ($this->view->displayHandlers
->has($display_id) && $this->view->displayHandlers
->get($display_id)
->acceptAttachments()) {
$displays[$display_id] = $display['display_title'];
}
}
$form['displays'] = [
'#title' => $this->t('Displays'),
'#type' => 'checkboxes',
'#description' => $this->t('Select which display or displays this should attach to.'),
'#options' => array_map('\\Drupal\\Component\\Utility\\Html::escape', $displays),
'#default_value' => $this->getOption('displays'),
];
break;
}
}
/**
* Perform any necessary changes to the form values prior to storage.
*
* There is no need for this function to actually store the data.
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
// It is very important to call the parent function here:
parent::submitOptionsForm($form, $form_state);
$section = $form_state->get('section');
switch ($section) {
case 'displays':
$form_state->setValue($section, array_filter($form_state->getValue($section)));
case 'inherit_arguments':
case 'inherit_pager':
case 'render_pager':
case 'inherit_exposed_filters':
case 'attachment_position':
$this->setOption($section, $form_state->getValue($section));
break;
}
}
/**
* {@inheritdoc}
*/
public function attachTo(ViewExecutable $view, $display_id, array &$build) {
$displays = $this->getOption('displays');
if (empty($displays[$display_id])) {
return;
}
if (!$this->access()) {
return;
}
$args = $this->getOption('inherit_arguments') ? $this->view->args : [];
$view->setArguments($args);
$view->setDisplay($this->display['id']);
if ($this->getOption('inherit_pager')) {
$view->display_handler->usesPager = $this->view->displayHandlers
->get($display_id)
->usesPager();
$view->display_handler
->setOption('pager', $this->view->displayHandlers
->get($display_id)
->getOption('pager'));
}
$attachment = $view->buildRenderable($this->display['id'], $args);
switch ($this->getOption('attachment_position')) {
case 'before':
$this->view->attachment_before[] = $attachment;
break;
case 'after':
$this->view->attachment_after[] = $attachment;
break;
case 'both':
$this->view->attachment_before[] = $attachment;
$this->view->attachment_after[] = $attachment;
break;
}
}
/**
* {@inheritdoc}
*/
public function usesExposed() {
// Attachment displays only use exposed widgets if they are set to inherit
// the exposed filter settings of their parent display.
if (!empty($this->options['inherit_exposed_filters']) && parent::usesExposed()) {
return TRUE;
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function displaysExposed() {
// If an attachment is set to inherit the exposed filter settings from its
// parent display, then don't render and display a second set of exposed
// filter widgets.
return $this->options['inherit_exposed_filters'] ? FALSE : TRUE;
}
public function renderPager() {
return $this->usesPager() && $this->getOption('render_pager');
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
Attachment::$usesPager | protected | property | Whether the display allows the use of a pager or not. | Overrides DisplayPluginBase::$usesPager | ||
Attachment::attachmentPositions | public | function | ||||
Attachment::attachTo | public | function | Allows displays to attach to other views. | Overrides DisplayPluginBase::attachTo | ||
Attachment::buildOptionsForm | public | function | Provide the default form for setting options. | Overrides DisplayPluginBase::buildOptionsForm | ||
Attachment::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides DisplayPluginBase::defineOptions | ||
Attachment::displaysExposed | public | function | Determines if this display should display the exposed filters widgets. | Overrides DisplayPluginBase::displaysExposed | ||
Attachment::execute | public | function | Executes the view and returns data in the format required. | Overrides DisplayPluginBase::execute | ||
Attachment::optionsSummary | public | function | Provide the summary for attachment options in the views UI. | Overrides DisplayPluginBase::optionsSummary | ||
Attachment::renderPager | public | function | Checks to see if the display plugins support pager rendering. | Overrides DisplayPluginBase::renderPager | ||
Attachment::submitOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | Overrides DisplayPluginBase::submitOptionsForm | ||
Attachment::usesExposed | public | function | Determines if this display uses exposed filters. | Overrides DisplayPluginBase::usesExposed | ||
DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
DependencyTrait::addDependency | protected | function | Adds a dependency. | |||
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | ||
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | ||
DisplayPluginBase::$default_display | public | property | ||||
DisplayPluginBase::$display | public | property | The display information coming directly from the view entity. | |||
DisplayPluginBase::$extenders | protected | property | Stores all available display extenders. | |||
DisplayPluginBase::$handlers | public | property | An array of instantiated handlers used in this display. | |||
DisplayPluginBase::$has_exposed | public | property | ||||
DisplayPluginBase::$output | public | property | Stores the rendered output of the display. | |||
DisplayPluginBase::$plugins | protected | property | An array of instantiated plugins used in this display. | |||
DisplayPluginBase::$unpackOptions | protected static | property | Static cache for unpackOptions, but not if we are in the UI. | |||
DisplayPluginBase::$usesAJAX | protected | property | Whether the display allows the use of AJAX or not. | 2 | ||
DisplayPluginBase::$usesAreas | protected | property | Whether the display allows area plugins. | 2 | ||
DisplayPluginBase::$usesAttachments | protected | property | Whether the display allows attachments. | 6 | ||
DisplayPluginBase::$usesMore | protected | property | Whether the display allows the use of a 'more' link or not. | 1 | ||
DisplayPluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | Overrides PluginBase::$usesOptions | 1 | |
DisplayPluginBase::$view | public | property | The top object of a view. | Overrides PluginBase::$view | ||
DisplayPluginBase::acceptAttachments | public | function | Determines whether this display can use attachments. | Overrides DisplayPluginInterface::acceptAttachments | ||
DisplayPluginBase::access | public | function | Determines if the user has access to this display of the view. | Overrides DisplayPluginInterface::access | ||
DisplayPluginBase::ajaxEnabled | public | function | Whether the display is actually using AJAX or not. | Overrides DisplayPluginInterface::ajaxEnabled | ||
DisplayPluginBase::applyDisplayCacheabilityMetadata | protected | function | Applies the cacheability of the current display to the given render array. | |||
DisplayPluginBase::buildBasicRenderable | public static | function | Builds a basic render array which can be properly render cached. | Overrides DisplayPluginInterface::buildBasicRenderable | 1 | |
DisplayPluginBase::buildRenderable | public | function | Builds a renderable array of the view. | Overrides DisplayPluginInterface::buildRenderable | 1 | |
DisplayPluginBase::buildRenderingLanguageOptions | protected | function | Returns the available rendering strategies for language-aware entities. | |||
DisplayPluginBase::calculateCacheMetadata | public | function | Calculates the display's cache metadata by inspecting each handler/plugin. | Overrides DisplayPluginInterface::calculateCacheMetadata | ||
DisplayPluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides PluginBase::calculateDependencies | 2 | |
DisplayPluginBase::defaultableSections | public | function | Lists the 'defaultable' sections and what items each section contains. | Overrides DisplayPluginInterface::defaultableSections | 1 | |
DisplayPluginBase::destroy | public | function | Clears a plugin. | Overrides PluginBase::destroy | ||
DisplayPluginBase::elementPreRender | public | function | #pre_render callback for view display rendering. | Overrides DisplayPluginInterface::elementPreRender | ||
DisplayPluginBase::getAllHandlers | protected | function | Gets all the handlers used by the display. | |||
DisplayPluginBase::getAllPlugins | protected | function | Gets all the plugins used by the display. | |||
DisplayPluginBase::getArgumentsTokens | public | function | Returns to tokens for arguments. | Overrides DisplayPluginInterface::getArgumentsTokens | ||
DisplayPluginBase::getArgumentText | public | function | Provides help text for the arguments. | Overrides DisplayPluginInterface::getArgumentText | 1 | |
DisplayPluginBase::getAttachedDisplays | public | function | Find out all displays which are attached to this display. | Overrides DisplayPluginInterface::getAttachedDisplays | ||
DisplayPluginBase::getCacheMetadata | public | function | Gets the cache metadata. | Overrides DisplayPluginInterface::getCacheMetadata | ||
DisplayPluginBase::getExtenders | public | function | Gets the display extenders. | Overrides DisplayPluginInterface::getExtenders | ||
DisplayPluginBase::getFieldLabels | public | function | Retrieves a list of fields for the current display. | Overrides DisplayPluginInterface::getFieldLabels | ||
DisplayPluginBase::getHandler | public | function | Get the handler object for a single handler. | Overrides DisplayPluginInterface::getHandler | ||
DisplayPluginBase::getHandlers | public | function | Get a full array of handlers for $type. This caches them. | Overrides DisplayPluginInterface::getHandlers | ||
DisplayPluginBase::getLinkDisplay | public | function | Returns the ID of the display to use when making links. | Overrides DisplayPluginInterface::getLinkDisplay | ||
DisplayPluginBase::getMoreUrl | protected | function | Get the more URL for this view. | |||
DisplayPluginBase::getOption | public | function | Gets an option, from this display or the default display. | Overrides DisplayPluginInterface::getOption | ||
DisplayPluginBase::getPagerText | public | function | Provides help text for pagers. | Overrides DisplayPluginInterface::getPagerText | 1 | |
DisplayPluginBase::getPath | public | function | Returns the base path to use for this display. | Overrides DisplayPluginInterface::getPath | 1 | |
DisplayPluginBase::getPlugin | public | function | Get the instance of a plugin, for example style or row. | Overrides DisplayPluginInterface::getPlugin | ||
DisplayPluginBase::getRoutedDisplay | public | function | Points to the display which can be linked by this display. | Overrides DisplayPluginInterface::getRoutedDisplay | ||
DisplayPluginBase::getSpecialBlocks | public | function | Provides the block system with any exposed widget blocks for this display. | Overrides DisplayPluginInterface::getSpecialBlocks | ||
DisplayPluginBase::getType | public | function | Returns the display type that this display requires. | Overrides DisplayPluginInterface::getType | 4 | |
DisplayPluginBase::getUrl | public | function | Returns a URL to $this display or its configured linked display. | Overrides DisplayPluginInterface::getUrl | ||
DisplayPluginBase::hasPath | public | function | Checks to see if the display has a 'path' field. | Overrides DisplayPluginInterface::hasPath | 1 | |
DisplayPluginBase::initDisplay | public | function | Initializes the display plugin. | Overrides DisplayPluginInterface::initDisplay | 1 | |
DisplayPluginBase::isBaseTableTranslatable | protected | function | Returns whether the base table is of a translatable entity type. | |||
DisplayPluginBase::isDefaultDisplay | public | function | Determines if this display is the 'default' display. | Overrides DisplayPluginInterface::isDefaultDisplay | 1 | |
DisplayPluginBase::isDefaulted | public | function | Determines if an option is set to use the default or current display. | Overrides DisplayPluginInterface::isDefaulted | ||
DisplayPluginBase::isEnabled | public | function | Whether the display is enabled. | Overrides DisplayPluginInterface::isEnabled | ||
DisplayPluginBase::isIdentifierUnique | public | function | Checks if the provided identifier is unique. | Overrides DisplayPluginInterface::isIdentifierUnique | ||
DisplayPluginBase::isMoreEnabled | public | function | Whether the display is using the 'more' link or not. | Overrides DisplayPluginInterface::isMoreEnabled | ||
DisplayPluginBase::isPagerEnabled | public | function | Whether the display is using a pager or not. | Overrides DisplayPluginInterface::isPagerEnabled | ||
DisplayPluginBase::mergeDefaults | public | function | Merges default values for all plugin types. | Overrides DisplayPluginInterface::mergeDefaults | ||
DisplayPluginBase::mergeHandler | protected | function | Merges handlers default values. | |||
DisplayPluginBase::mergePlugin | protected | function | Merges plugins default values. | |||
DisplayPluginBase::newDisplay | public | function | Reacts on adding a display. | Overrides DisplayPluginInterface::newDisplay | 1 | |
DisplayPluginBase::optionLink | public | function | Returns a link to a section of a form. | Overrides DisplayPluginInterface::optionLink | ||
DisplayPluginBase::optionsOverride | public | function | If override/revert was clicked, perform the proper toggle. | Overrides DisplayPluginInterface::optionsOverride | ||
DisplayPluginBase::outputIsEmpty | public | function | Is the output of the view empty. | Overrides DisplayPluginInterface::outputIsEmpty | ||
DisplayPluginBase::overrideOption | public | function | Set an option and force it to be an override. | Overrides DisplayPluginInterface::overrideOption | ||
DisplayPluginBase::preExecute | public | function | Sets up any variables on the view prior to execution. | Overrides DisplayPluginInterface::preExecute | ||
DisplayPluginBase::preview | public | function | Renders the display for the purposes of a live preview. | Overrides DisplayPluginInterface::preview | 3 | |
DisplayPluginBase::query | public | function | Add anything to the query that we might need to. | Overrides PluginBase::query | 1 | |
DisplayPluginBase::remove | public | function | Reacts on deleting a display. | Overrides DisplayPluginInterface::remove | 2 | |
DisplayPluginBase::render | public | function | Renders this display. | Overrides DisplayPluginInterface::render | 3 | |
DisplayPluginBase::renderArea | public | function | Renders one of the available areas. | Overrides DisplayPluginInterface::renderArea | ||
DisplayPluginBase::renderFilters | public | function | Does nothing (obsolete function). | Overrides DisplayPluginInterface::renderFilters | ||
DisplayPluginBase::renderMoreLink | public | function | Renders the 'more' link. | Overrides DisplayPluginInterface::renderMoreLink | ||
DisplayPluginBase::setOption | public | function | Sets an option, on this display or the default display. | Overrides DisplayPluginInterface::setOption | ||
DisplayPluginBase::setOverride | public | function | Flip the override setting for the given section. | Overrides DisplayPluginInterface::setOverride | ||
DisplayPluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | ||
DisplayPluginBase::useGroupBy | public | function | Does the display have groupby enabled? | Overrides DisplayPluginInterface::useGroupBy | ||
DisplayPluginBase::useMoreAlways | public | function | Should the enabled display more link be shown when no more items? | Overrides DisplayPluginInterface::useMoreAlways | ||
DisplayPluginBase::useMoreText | public | function | Does the display have custom link text? | Overrides DisplayPluginInterface::useMoreText | ||
DisplayPluginBase::usesAJAX | public | function | Whether the display allows the use of AJAX or not. | Overrides DisplayPluginInterface::usesAJAX | 2 | |
DisplayPluginBase::usesAreas | public | function | Returns whether the display can use areas. | Overrides DisplayPluginInterface::usesAreas | 2 | |
DisplayPluginBase::usesAttachments | public | function | Returns whether the display can use attachments. | Overrides DisplayPluginInterface::usesAttachments | 6 | |
DisplayPluginBase::usesExposedFormInBlock | public | function | Checks to see if the display can put the exposed form in a block. | Overrides DisplayPluginInterface::usesExposedFormInBlock | 1 | |
DisplayPluginBase::usesFields | public | function | Determines if the display's style uses fields. | Overrides DisplayPluginInterface::usesFields | ||
DisplayPluginBase::usesLinkDisplay | public | function | Checks to see if the display has some need to link to another display. | Overrides DisplayPluginInterface::usesLinkDisplay | 1 | |
DisplayPluginBase::usesMore | public | function | Whether the display allows the use of a 'more' link or not. | Overrides DisplayPluginInterface::usesMore | 1 | |
DisplayPluginBase::usesPager | public | function | Whether the display allows the use of a pager or not. | Overrides DisplayPluginInterface::usesPager | 4 | |
DisplayPluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | 3 | |
DisplayPluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides PluginBase::validateOptionsForm | 2 | |
DisplayPluginBase::viewExposedFormBlocks | public | function | Renders the exposed form as block. | Overrides DisplayPluginInterface::viewExposedFormBlocks | ||
DisplayPluginBase::__construct | public | function | Constructs a new DisplayPluginBase object. | Overrides PluginBase::__construct | 3 | |
PluginBase::$definition | public | property | Plugins' 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::$position | public | property | The handler position. | |||
PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | ||
PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 60 | |
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::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::init | public | function | Initialize the plugin. | Overrides ViewsPluginInterface::init | 6 | |
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::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | ||
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 | |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | ||
PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | |||
PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | ||
PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | ||
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.