class DisplayLink
Same name in other branches
- 9 core/modules/views/src/Plugin/views/area/DisplayLink.php \Drupal\views\Plugin\views\area\DisplayLink
- 10 core/modules/views/src/Plugin/views/area/DisplayLink.php \Drupal\views\Plugin\views\area\DisplayLink
- 11.x core/modules/views/src/Plugin/views/area/DisplayLink.php \Drupal\views\Plugin\views\area\DisplayLink
Views area display_link handler.
Plugin annotation
@ViewsArea("display_link");
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\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\area\AreaPluginBase extends \Drupal\views\Plugin\views\HandlerBase
- class \Drupal\views\Plugin\views\area\DisplayLink extends \Drupal\views\Plugin\views\area\AreaPluginBase
- class \Drupal\views\Plugin\views\area\AreaPluginBase extends \Drupal\views\Plugin\views\HandlerBase
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- 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 DisplayLink
Related topics
File
-
core/
modules/ views/ src/ Plugin/ views/ area/ DisplayLink.php, line 18
Namespace
Drupal\views\Plugin\views\areaView source
class DisplayLink extends AreaPluginBase {
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['display_id'] = [
'default' => NULL,
];
$options['label'] = [
'default' => NULL,
];
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$allowed_displays = [];
$displays = $this->view->storage
->get('display');
foreach ($displays as $display_id => $display) {
if (!$this->isPathBasedDisplay($display_id)) {
unset($displays[$display_id]);
continue;
}
$allowed_displays[$display_id] = $display['display_title'];
}
$form['description'] = [
[
'#markup' => $this->t('To make sure the results are the same when switching to the other display, it is recommended to make sure the display:'),
],
[
'#theme' => 'item_list',
'#items' => [
$this->t('Has a path.'),
$this->t('Has the same filter criteria.'),
$this->t('Has the same sort criteria.'),
$this->t('Has the same pager settings.'),
$this->t('Has the same contextual filters.'),
],
],
];
if (!$allowed_displays) {
$form['empty_message'] = [
'#markup' => '<p><em>' . $this->t('There are no path-based displays available.') . '</em></p>',
];
}
else {
$form['display_id'] = [
'#title' => $this->t('Display'),
'#type' => 'select',
'#options' => $allowed_displays,
'#default_value' => $this->options['display_id'],
'#required' => TRUE,
];
$form['label'] = [
'#title' => $this->t('Label'),
'#description' => $this->t('The text of the link.'),
'#type' => 'textfield',
'#default_value' => $this->options['label'],
'#required' => TRUE,
];
}
}
/**
* {@inheritdoc}
*/
public function validate() {
$errors = parent::validate();
// Do not add errors for the default display if it is not displayed in the
// UI.
if ($this->displayHandler
->isDefaultDisplay() && !\Drupal::config('views.settings')->get('ui.show.master_display')) {
return $errors;
}
// Ajax errors can cause the plugin to be added without any settings.
$linked_display_id = !empty($this->options['display_id']) ? $this->options['display_id'] : NULL;
if (!$linked_display_id) {
$errors[] = $this->t('%current_display: The link in the %area area has no configured display.', [
'%current_display' => $this->displayHandler->display['display_title'],
'%area' => $this->areaType,
]);
return $errors;
}
// Check if the linked display hasn't been removed.
if (!$this->view->displayHandlers
->get($linked_display_id)) {
$errors[] = $this->t('%current_display: The link in the %area area points to the %linked_display display which no longer exists.', [
'%current_display' => $this->displayHandler->display['display_title'],
'%area' => $this->areaType,
'%linked_display' => $this->options['display_id'],
]);
return $errors;
}
// Check if the linked display is a path-based display.
if (!$this->isPathBasedDisplay($linked_display_id)) {
$errors[] = $this->t('%current_display: The link in the %area area points to the %linked_display display which does not have a path.', [
'%current_display' => $this->displayHandler->display['display_title'],
'%area' => $this->areaType,
'%linked_display' => $this->view->displayHandlers
->get($linked_display_id)->display['display_title'],
]);
return $errors;
}
// Check if options of the linked display are equal to the options of the
// current display. We "only" show a warning here, because even though we
// recommend keeping the display options equal, we do not want to enforce
// this.
$unequal_options = [
'filters' => t('Filter criteria'),
'sorts' => t('Sort criteria'),
'pager' => t('Pager'),
'arguments' => t('Contextual filters'),
];
foreach (array_keys($unequal_options) as $option) {
if ($this->hasEqualOptions($linked_display_id, $option)) {
unset($unequal_options[$option]);
}
}
if ($unequal_options) {
$warning = $this->t('%current_display: The link in the %area area points to the %linked_display display which uses different settings than the %current_display display for: %unequal_options. To make sure users see the exact same result when clicking the link, please check that the settings are the same.', [
'%current_display' => $this->displayHandler->display['display_title'],
'%area' => $this->areaType,
'%linked_display' => $this->view->displayHandlers
->get($linked_display_id)->display['display_title'],
'%unequal_options' => implode(', ', $unequal_options),
]);
$this->messenger()
->addWarning($warning);
}
return $errors;
}
/**
* {@inheritdoc}
*/
public function render($empty = FALSE) {
if ($empty && empty($this->options['empty']) || empty($this->options['display_id'])) {
return [];
}
if (!$this->isPathBasedDisplay($this->options['display_id'])) {
return [];
}
// Get query parameters from the exposed input and pager.
$query = $this->view
->getExposedInput();
if ($current_page = $this->view
->getCurrentPage()) {
$query['page'] = $current_page;
}
// @todo Remove this parsing once these are removed from the request in
// https://www.drupal.org/node/2504709.
foreach ([
'view_name',
'view_display_id',
'view_args',
'view_path',
'view_dom_id',
'pager_element',
'view_base_path',
AjaxResponseSubscriber::AJAX_REQUEST_PARAMETER,
FormBuilderInterface::AJAX_FORM_REQUEST,
MainContentViewSubscriber::WRAPPER_FORMAT,
] as $key) {
unset($query[$key]);
}
// Set default classes.
$classes = [
'views-display-link',
'views-display-link-' . $this->options['display_id'],
];
if ($this->options['display_id'] === $this->view->current_display) {
$classes[] = 'is-active';
}
return [
'#type' => 'link',
'#title' => $this->options['label'],
'#url' => $this->view
->getUrl($this->view->args, $this->options['display_id'])
->setOptions([
'query' => $query,
]),
'#options' => [
'view' => $this->view,
'target_display_id' => $this->options['display_id'],
'attributes' => [
'class' => $classes,
],
],
];
}
/**
* Check if a views display is a path-based display.
*
* @param string $display_id
* The display ID to check.
*
* @return bool
* Whether the display ID is an allowed display or not.
*/
protected function isPathBasedDisplay($display_id) {
$loaded_display = $this->view->displayHandlers
->get($display_id);
return $loaded_display instanceof PathPluginBase;
}
/**
* Check if the options of a views display are equal to the current display.
*
* @param string $display_id
* The display ID to check.
* @param string $option
* The option to check.
*
* @return bool
* Whether the option of the view display are equal to the current display
* or not.
*/
protected function hasEqualOptions($display_id, $option) {
$loaded_display = $this->view->displayHandlers
->get($display_id);
return $loaded_display->getOption($option) === $this->displayHandler
->getOption($option);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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 | |
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 | |
DisplayLink::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides AreaPluginBase::buildOptionsForm | |
DisplayLink::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides AreaPluginBase::defineOptions | |
DisplayLink::hasEqualOptions | protected | function | Check if the options of a views display are equal to the current display. | ||
DisplayLink::isPathBasedDisplay | protected | function | Check if a views display is a path-based display. | ||
DisplayLink::render | public | function | Render the area. | Overrides AreaPluginBase::render | |
DisplayLink::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides HandlerBase::validate | |
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::postExecute | public | function | Run after the view is executed, before the result is cached. | Overrides ViewsHandlerInterface::postExecute | |
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. | ||
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 44 |
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::$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::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 62 |
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::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::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::submitOptionsForm | public | function | Handle any special handling on the validate form. | Overrides ViewsPluginInterface::submitOptionsForm | 16 |
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. | |||
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 | 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.