The base display plugin for path/callbacks. This is used for pages, feeds.
Expanded class hierarchy of PathPluginBase
abstract class PathPluginBase extends DisplayPluginBase {
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::hasPath().
*/
public function hasPath() {
return TRUE;
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase:defineOptions().
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['path'] = array(
'default' => '',
);
return $options;
}
/**
* Add this display's path information to Drupal's menu system.
*/
public function executeHookMenu($callbacks) {
$items = array();
// Replace % with the link to our standard views argument loader
// views_arg_load -- which lives in views.module
$bits = explode('/', $this
->getOption('path'));
$page_arguments = array(
$this->view->storage->name,
$this->display['id'],
);
$this->view
->initHandlers();
$view_arguments = $this->view->argument;
// Replace % with %views_arg for menu autoloading and add to the
// page arguments so the argument actually comes through.
foreach ($bits as $pos => $bit) {
if ($bit == '%') {
$argument = array_shift($view_arguments);
if (!empty($argument->options['specify_validation']) && $argument->options['validate']['type'] != 'none') {
$bits[$pos] = '%views_arg';
}
$page_arguments[] = $pos;
}
}
$path = implode('/', $bits);
$access_plugin = $this
->getPlugin('access');
if (!isset($access_plugin)) {
$access_plugin = drupal_container()
->get("plugin.manager.views.access")
->createInstance('none');
}
// Get access callback might return an array of the callback + the dynamic arguments.
$access_plugin_callback = $access_plugin
->get_access_callback();
if (is_array($access_plugin_callback)) {
$access_arguments = array();
// Find the plugin arguments.
$access_plugin_method = array_shift($access_plugin_callback);
$access_plugin_arguments = array_shift($access_plugin_callback);
if (!is_array($access_plugin_arguments)) {
$access_plugin_arguments = array();
}
$access_arguments[0] = array(
$access_plugin_method,
&$access_plugin_arguments,
);
// Move the plugin arguments to the access arguments array.
$i = 1;
foreach ($access_plugin_arguments as $key => $value) {
if (is_int($value)) {
$access_arguments[$i] = $value;
$access_plugin_arguments[$key] = $i;
$i++;
}
}
}
else {
$access_arguments = array(
$access_plugin_callback,
);
}
if ($path) {
$items[$path] = array(
// default views page entry
'page callback' => 'views_page',
'page arguments' => $page_arguments,
// Default access check (per display)
'access callback' => 'views_access',
'access arguments' => $access_arguments,
// Identify URL embedded arguments and correlate them to a handler
'load arguments' => array(
$this->view->storage->name,
$this->display['id'],
'%index',
),
);
$menu = $this
->getOption('menu');
if (empty($menu)) {
$menu = array(
'type' => 'none',
);
}
// Set the title and description if we have one.
if ($menu['type'] != 'none') {
$items[$path]['title'] = $menu['title'];
$items[$path]['description'] = $menu['description'];
}
if (isset($menu['weight'])) {
$items[$path]['weight'] = intval($menu['weight']);
}
switch ($menu['type']) {
case 'none':
default:
$items[$path]['type'] = MENU_CALLBACK;
break;
case 'normal':
$items[$path]['type'] = MENU_NORMAL_ITEM;
// Insert item into the proper menu
$items[$path]['menu_name'] = $menu['name'];
break;
case 'tab':
$items[$path]['type'] = MENU_LOCAL_TASK;
break;
case 'default tab':
$items[$path]['type'] = MENU_DEFAULT_LOCAL_TASK;
break;
}
// Add context for contextual links.
// @see menu_contextual_links()
if (!empty($menu['context'])) {
$items[$path]['context'] = MENU_CONTEXT_INLINE;
}
// If this is a 'default' tab, check to see if we have to create teh
// parent menu item.
if ($menu['type'] == 'default tab') {
$tab_options = $this
->getOption('tab_options');
if (!empty($tab_options['type']) && $tab_options['type'] != 'none') {
$bits = explode('/', $path);
// Remove the last piece.
$bit = array_pop($bits);
// we can't do this if they tried to make the last path bit variable.
// @todo: We can validate this.
if ($bit != '%views_arg' && !empty($bits)) {
$default_path = implode('/', $bits);
$items[$default_path] = array(
// default views page entry
'page callback' => 'views_page',
'page arguments' => $page_arguments,
// Default access check (per display)
'access callback' => 'views_access',
'access arguments' => $access_arguments,
// Identify URL embedded arguments and correlate them to a handler
'load arguments' => array(
$this->view->storage->name,
$this->display['id'],
'%index',
),
'title' => $tab_options['title'],
'description' => $tab_options['description'],
'menu_name' => $tab_options['name'],
);
switch ($tab_options['type']) {
default:
case 'normal':
$items[$default_path]['type'] = MENU_NORMAL_ITEM;
break;
case 'tab':
$items[$default_path]['type'] = MENU_LOCAL_TASK;
break;
}
if (isset($tab_options['weight'])) {
$items[$default_path]['weight'] = intval($tab_options['weight']);
}
}
}
}
}
return $items;
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::execute().
*/
public function execute() {
// Prior to this being called, the $view should already be set to this
// display, and arguments should be set on the view.
$this->view
->build();
if (!empty($this->view->build_info['fail'])) {
throw new NotFoundHttpException();
}
if (!empty($this->view->build_info['denied'])) {
throw new AccessDeniedHttpException();
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary().
*/
public function optionsSummary(&$categories, &$options) {
parent::optionsSummary($categories, $options);
$categories['page'] = array(
'title' => t('Page settings'),
'column' => 'second',
'build' => array(
'#weight' => -10,
),
);
$path = strip_tags($this
->getOption('path'));
if (empty($path)) {
$path = t('No path is set');
}
else {
$path = '/' . $path;
}
$options['path'] = array(
'category' => 'page',
'title' => t('Path'),
'value' => views_ui_truncate($path, 24),
);
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::buildOptionsForm()..
*/
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($form, $form_state);
switch ($form_state['section']) {
case 'path':
$form['#title'] .= t('The menu path or URL of this view');
$form['path'] = array(
'#type' => 'textfield',
'#description' => t('This view will be displayed by visiting this path on your site. You may use "%" in your URL to represent values that will be used for contextual filters: For example, "node/%/feed".'),
'#default_value' => $this
->getOption('path'),
'#field_prefix' => '<span dir="ltr">' . url(NULL, array(
'absolute' => TRUE,
)),
'#field_suffix' => '</span>‎',
'#attributes' => array(
'dir' => 'ltr',
),
);
break;
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::validateOptionsForm().
*/
public function validateOptionsForm(&$form, &$form_state) {
parent::validateOptionsForm($form, $form_state);
if ($form_state['section'] == 'path') {
if (strpos($form_state['values']['path'], '%') === 0) {
form_error($form['path'], t('"%" may not be used for the first segment of a path.'));
}
// Automatically remove '/' and trailing whitespace from path.
$form_state['values']['path'] = trim($form_state['values']['path'], '/ ');
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::submitOptionsForm().
*/
public function submitOptionsForm(&$form, &$form_state) {
parent::submitOptionsForm($form, $form_state);
if ($form_state['section'] == 'path') {
$this
->setOption('path', $form_state['values']['path']);
}
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DisplayPluginBase:: |
property | Stores all available display extenders. | ||
DisplayPluginBase:: |
property | |||
DisplayPluginBase:: |
public | property | Stores the rendered output of the display. | |
DisplayPluginBase:: |
protected | property | An array of instantiated plugins used in this display. | |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of AJAX or not. | 1 |
DisplayPluginBase:: |
protected | property | Whether the display allows area plugins. | 1 |
DisplayPluginBase:: |
protected | property | Whether the display allows attachments. | 4 |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of a 'more' link or not. | |
DisplayPluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
DisplayPluginBase:: |
protected | property | Whether the display allows the use of a pager or not. | 2 |
DisplayPluginBase:: |
property |
The top object of a view. Overrides PluginBase:: |
||
DisplayPluginBase:: |
public | function | Determines whether this display can use attachments. | |
DisplayPluginBase:: |
public | function | Determine if the user has access to this display of the view. | |
DisplayPluginBase:: |
public | function | Allow displays to attach to other views. | 2 |
DisplayPluginBase:: |
public | function | Static member function to list which sections are defaultable and what items each section contains. | 1 |
DisplayPluginBase:: |
public | function |
Clears a plugin. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function | Determine if this display should display the exposed filters widgets, so the view will know whether or not to render them. | 1 |
DisplayPluginBase:: |
protected | function | Format a list of theme templates for output by the theme info helper. | |
DisplayPluginBase:: |
public | function | Returns to tokens for arguments. | |
DisplayPluginBase:: |
public | function | Provide some helpful text for the arguments. The result should contain of an array with | 1 |
DisplayPluginBase:: |
public | function | Retrieve a list of fields for the current display with the relationship associated if it exists. | |
DisplayPluginBase:: |
public | function | Get the handler object for a single handler. | |
DisplayPluginBase:: |
public | function | Get a full array of handlers for $type. This caches them. | |
DisplayPluginBase:: |
public | function | Check to see which display to use when creating links within a view using this display. | |
DisplayPluginBase:: |
public | function | Intelligently get an option either from this display or from the default display, if directed to do so. | |
DisplayPluginBase:: |
public | function | Provide some helpful text for pagers. | 1 |
DisplayPluginBase:: |
public | function | Return the base path to use for this display. | |
DisplayPluginBase:: |
public | function | Get the instance of a plugin, for example style or row. | |
DisplayPluginBase:: |
public | function | Provide the block system with any exposed widget blocks for this display. | |
DisplayPluginBase:: |
protected | function | Displays can require a certain type of style plugin. By default, they will be 'normal'. | 1 |
DisplayPluginBase:: |
public | function | ||
DisplayPluginBase:: |
public | function | If this display creates a block, implement one of these. | |
DisplayPluginBase:: |
public | function | If this display creates a page with a menu item, implement it here. | |
DisplayPluginBase:: |
public | function | 1 | |
DisplayPluginBase:: |
public | function | Whether the display is actually using AJAX or not. | |
DisplayPluginBase:: |
public | function | Determine if this display is the 'default' display which contains fallback settings | 1 |
DisplayPluginBase:: |
public | function | Determine if a given option is set to use the default display or the current display | |
DisplayPluginBase:: |
public | function | Whether the display is enabled. | |
DisplayPluginBase:: |
public | function | Check if the provided identifier is unique. | |
DisplayPluginBase:: |
public | function | Whether the display is using the 'more' link or not. | |
DisplayPluginBase:: |
public | function | Whether the display is using a pager or not. | |
DisplayPluginBase:: |
public | function | Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this. | |
DisplayPluginBase:: |
public | function | If override/revert was clicked, perform the proper toggle. | |
DisplayPluginBase:: |
public | function | Set an option and force it to be an override. | |
DisplayPluginBase:: |
public | function | Set up any variables on the view prior to execution. These are separated from execute because they are extremely common and unlikely to be overridden on an individual display. | |
DisplayPluginBase:: |
function | Fully render the display for the purposes of a live preview or some other AJAXy reason. | 2 | |
DisplayPluginBase:: |
public | function |
Inject anything into the query that the display handler needs. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function | Render this display. | 1 |
DisplayPluginBase:: |
public | function | ||
DisplayPluginBase:: |
public | function | ||
DisplayPluginBase:: |
public | function | Not all display plugins will support filtering | |
DisplayPluginBase:: |
public | function | Render the footer of the view. | |
DisplayPluginBase:: |
public | function | Render the header of the view. | |
DisplayPluginBase:: |
public | function | Render the 'more' link | |
DisplayPluginBase:: |
public | function | Not all display plugins will suppert pager rendering. | 1 |
DisplayPluginBase:: |
public | function | Intelligently set an option either from this display or from the default display, if directed to do so. | |
DisplayPluginBase:: |
public | function | Flip the override setting for the given section. | |
DisplayPluginBase:: |
public | function | Does the display have groupby enabled? | |
DisplayPluginBase:: |
public | function | Should the enabled display more link be shown when no more items? | |
DisplayPluginBase:: |
public | function | Does the display have custom link text? | |
DisplayPluginBase:: |
public | function | Whether the display allows the use of AJAX or not. | 1 |
DisplayPluginBase:: |
public | function | Returns whether the display can use areas. | 1 |
DisplayPluginBase:: |
public | function | Returns whether the display can use attachments. | 4 |
DisplayPluginBase:: |
public | function | Check to see if the display needs a breadcrumb | 1 |
DisplayPluginBase:: |
public | function | Determine if this display uses exposed filters, so the view will know whether or not to build them. | 2 |
DisplayPluginBase:: |
public | function | Check to see if the display can put the exposed formin a block. | |
DisplayPluginBase:: |
public | function | Determine if the display's style uses fields. | |
DisplayPluginBase:: |
public | function | Check to see if the display has some need to link to another display. | 1 |
DisplayPluginBase:: |
public | function | Whether the display allows the use of a 'more' link or not. | |
DisplayPluginBase:: |
public | function | Whether the display allows the use of a pager or not. | 2 |
DisplayPluginBase:: |
public | function |
Make sure the display and all associated handlers are valid. Overrides PluginBase:: |
1 |
DisplayPluginBase:: |
public | function | Render any special blocks provided for this display. | |
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::buildOptionsForm().. Overrides DisplayPluginBase:: |
2 |
PathPluginBase:: |
protected | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase:defineOptions(). Overrides DisplayPluginBase:: |
2 |
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::execute(). Overrides DisplayPluginBase:: |
2 |
PathPluginBase:: |
public | function | Add this display's path information to Drupal's menu system. | |
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::hasPath(). Overrides DisplayPluginBase:: |
|
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary(). Overrides DisplayPluginBase:: |
2 |
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::submitOptionsForm(). Overrides DisplayPluginBase:: |
2 |
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::validateOptionsForm(). Overrides DisplayPluginBase:: |
1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |