The plugin that handles a full page.
@Plugin(
id = "page",
title = @Translation("Page"),
help = @Translation("Display the view as a page, with a URL and menu links."),
uses_hook_menu = TRUE,
contextual_links_locations = {"page"},
theme = "views_view",
admin = @Translation("Page")
)
Expanded class hierarchy of Page
class Page extends PathPluginBase {
/**
* Whether the display allows attachments.
*
* @var bool
*/
protected $usesAttachments = TRUE;
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::usesBreadcrumb().
*/
public function usesBreadcrumb() {
return TRUE;
}
/**
* Overrides \Drupal\views\Plugin\views\display\PathPluginBase::defineOptions().
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['menu'] = array(
'contains' => array(
'type' => array(
'default' => 'none',
),
// Do not translate menu and title as menu system will.
'title' => array(
'default' => '',
'translatable' => FALSE,
),
'description' => array(
'default' => '',
'translatable' => FALSE,
),
'weight' => array(
'default' => 0,
),
'name' => array(
'default' => variable_get('menu_default_node_menu', 'navigation'),
),
'context' => array(
'default' => '',
),
),
);
$options['tab_options'] = array(
'contains' => array(
'type' => array(
'default' => 'none',
),
// Do not translate menu and title as menu system will.
'title' => array(
'default' => '',
'translatable' => FALSE,
),
'description' => array(
'default' => '',
'translatable' => FALSE,
),
'weight' => array(
'default' => 0,
),
'name' => array(
'default' => 'navigation',
),
),
);
return $options;
}
/**
* Overrides \Drupal\views\Plugin\views\display\PathPluginBase::execute().
*/
public function execute() {
parent::execute();
// Let the world know that this is the page view we're using.
views_set_page_view($this->view);
$this->view
->getBreadcrumb(TRUE);
// And now render the view.
$render = $this->view
->render();
// First execute the view so it's possible to get tokens for the title.
// And the title, which is much easier.
drupal_set_title(filter_xss_admin($this->view
->getTitle()), PASS_THROUGH);
return $render;
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary().
*/
public function optionsSummary(&$categories, &$options) {
parent::optionsSummary($categories, $options);
$menu = $this
->getOption('menu');
if (!is_array($menu)) {
$menu = array(
'type' => 'none',
);
}
switch ($menu['type']) {
case 'none':
default:
$menu_str = t('No menu');
break;
case 'normal':
$menu_str = t('Normal: @title', array(
'@title' => $menu['title'],
));
break;
case 'tab':
case 'default tab':
$menu_str = t('Tab: @title', array(
'@title' => $menu['title'],
));
break;
}
$options['menu'] = array(
'category' => 'page',
'title' => t('Menu'),
'value' => views_ui_truncate($menu_str, 24),
);
// This adds a 'Settings' link to the style_options setting if the style has options.
if ($menu['type'] == 'default tab') {
$options['menu']['setting'] = t('Parent menu item');
$options['menu']['links']['tab_options'] = t('Change settings for the parent menu');
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\callbackPluginBase::buildOptionsForm().
*/
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($form, $form_state);
switch ($form_state['section']) {
case 'menu':
$form['#title'] .= t('Menu item entry');
$form['menu'] = array(
'#prefix' => '<div class="clearfix">',
'#suffix' => '</div>',
'#tree' => TRUE,
);
$menu = $this
->getOption('menu');
if (empty($menu)) {
$menu = array(
'type' => 'none',
'title' => '',
'weight' => 0,
);
}
$form['menu']['type'] = array(
'#prefix' => '<div class="views-left-30">',
'#suffix' => '</div>',
'#title' => t('Type'),
'#type' => 'radios',
'#options' => array(
'none' => t('No menu entry'),
'normal' => t('Normal menu entry'),
'tab' => t('Menu tab'),
'default tab' => t('Default menu tab'),
),
'#default_value' => $menu['type'],
);
$form['menu']['title'] = array(
'#prefix' => '<div class="views-left-50">',
'#title' => t('Title'),
'#type' => 'textfield',
'#default_value' => $menu['title'],
'#description' => t('If set to normal or tab, enter the text to use for the menu item.'),
'#states' => array(
'visible' => array(
array(
':input[name="menu[type]"]' => array(
'value' => 'normal',
),
),
array(
':input[name="menu[type]"]' => array(
'value' => 'tab',
),
),
array(
':input[name="menu[type]"]' => array(
'value' => 'default tab',
),
),
),
),
);
$form['menu']['description'] = array(
'#title' => t('Description'),
'#type' => 'textfield',
'#default_value' => $menu['description'],
'#description' => t("If set to normal or tab, enter the text to use for the menu item's description."),
'#states' => array(
'visible' => array(
array(
':input[name="menu[type]"]' => array(
'value' => 'normal',
),
),
array(
':input[name="menu[type]"]' => array(
'value' => 'tab',
),
),
array(
':input[name="menu[type]"]' => array(
'value' => 'default tab',
),
),
),
),
);
// Only display the menu selector if menu module is enabled.
if (module_exists('menu')) {
$form['menu']['name'] = array(
'#title' => t('Menu'),
'#type' => 'select',
'#options' => menu_get_menus(),
'#default_value' => $menu['name'],
'#description' => t('Insert item into an available menu.'),
'#states' => array(
'visible' => array(
array(
':input[name="menu[type]"]' => array(
'value' => 'normal',
),
),
array(
':input[name="menu[type]"]' => array(
'value' => 'tab',
),
),
),
),
);
}
else {
$form['menu']['name'] = array(
'#type' => 'value',
'#value' => $menu['name'],
);
$form['menu']['markup'] = array(
'#markup' => t('Menu selection requires the activation of menu module.'),
);
}
$form['menu']['weight'] = array(
'#title' => t('Weight'),
'#type' => 'textfield',
'#default_value' => isset($menu['weight']) ? $menu['weight'] : 0,
'#description' => t('The lower the weight the higher/further left it will appear.'),
'#states' => array(
'visible' => array(
array(
':input[name="menu[type]"]' => array(
'value' => 'normal',
),
),
array(
':input[name="menu[type]"]' => array(
'value' => 'tab',
),
),
array(
':input[name="menu[type]"]' => array(
'value' => 'default tab',
),
),
),
),
);
$form['menu']['context'] = array(
'#title' => t('Context'),
'#suffix' => '</div>',
'#type' => 'checkbox',
'#default_value' => !empty($menu['context']),
'#description' => t('Displays the link in contextual links'),
'#states' => array(
'visible' => array(
':input[name="menu[type]"]' => array(
'value' => 'tab',
),
),
),
);
break;
case 'tab_options':
$form['#title'] .= t('Default tab options');
$tab_options = $this
->getOption('tab_options');
if (empty($tab_options)) {
$tab_options = array(
'type' => 'none',
'title' => '',
'weight' => 0,
);
}
$form['tab_markup'] = array(
'#markup' => '<div class="form-item description">' . t('When providing a menu item as a tab, Drupal needs to know what the parent menu item of that tab will be. Sometimes the parent will already exist, but other times you will need to have one created. The path of a parent item will always be the same path with the last part left off. i.e, if the path to this view is <em>foo/bar/baz</em>, the parent path would be <em>foo/bar</em>.') . '</div>',
);
$form['tab_options'] = array(
'#prefix' => '<div class="clearfix">',
'#suffix' => '</div>',
'#tree' => TRUE,
);
$form['tab_options']['type'] = array(
'#prefix' => '<div class="views-left-25">',
'#suffix' => '</div>',
'#title' => t('Parent menu item'),
'#type' => 'radios',
'#options' => array(
'none' => t('Already exists'),
'normal' => t('Normal menu item'),
'tab' => t('Menu tab'),
),
'#default_value' => $tab_options['type'],
);
$form['tab_options']['title'] = array(
'#prefix' => '<div class="views-left-75">',
'#title' => t('Title'),
'#type' => 'textfield',
'#default_value' => $tab_options['title'],
'#description' => t('If creating a parent menu item, enter the title of the item.'),
'#states' => array(
'visible' => array(
array(
':input[name="tab_options[type]"]' => array(
'value' => 'normal',
),
),
array(
':input[name="tab_options[type]"]' => array(
'value' => 'tab',
),
),
),
),
);
$form['tab_options']['description'] = array(
'#title' => t('Description'),
'#type' => 'textfield',
'#default_value' => $tab_options['description'],
'#description' => t('If creating a parent menu item, enter the description of the item.'),
'#states' => array(
'visible' => array(
array(
':input[name="tab_options[type]"]' => array(
'value' => 'normal',
),
),
array(
':input[name="tab_options[type]"]' => array(
'value' => 'tab',
),
),
),
),
);
// Only display the menu selector if menu module is enabled.
if (module_exists('menu')) {
$form['tab_options']['name'] = array(
'#title' => t('Menu'),
'#type' => 'select',
'#options' => menu_get_menus(),
'#default_value' => $tab_options['name'],
'#description' => t('Insert item into an available menu.'),
'#states' => array(
'visible' => array(
':input[name="tab_options[type]"]' => array(
'value' => 'normal',
),
),
),
);
}
else {
$form['tab_options']['name'] = array(
'#type' => 'value',
'#value' => $tab_options['name'],
);
$form['tab_options']['markup'] = array(
'#markup' => t('Menu selection requires the activation of menu module.'),
);
}
$form['tab_options']['weight'] = array(
'#suffix' => '</div>',
'#title' => t('Tab weight'),
'#type' => 'textfield',
'#default_value' => $tab_options['weight'],
'#size' => 5,
'#description' => t('If the parent menu item is a tab, enter the weight of the tab. The lower the number, the more to the left it will be.'),
'#states' => array(
'visible' => array(
':input[name="tab_options[type]"]' => array(
'value' => 'tab',
),
),
),
);
break;
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\callbackPluginBase::validateOptionsForm().
*/
public function validateOptionsForm(&$form, &$form_state) {
parent::validateOptionsForm($form, $form_state);
if ($form_state['section'] == 'menu') {
$path = $this
->getOption('path');
if ($form_state['values']['menu']['type'] == 'normal' && strpos($path, '%') !== FALSE) {
form_error($form['menu']['type'], t('Views cannot create normal menu items for paths with a % in them.'));
}
if ($form_state['values']['menu']['type'] == 'default tab' || $form_state['values']['menu']['type'] == 'tab') {
$bits = explode('/', $path);
$last = array_pop($bits);
if ($last == '%') {
form_error($form['menu']['type'], t('A display whose path ends with a % cannot be a tab.'));
}
}
if ($form_state['values']['menu']['type'] != 'none' && empty($form_state['values']['menu']['title'])) {
form_error($form['menu']['title'], t('Title is required for this menu type.'));
}
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\callbackPluginBase::submitOptionsForm().
*/
public function submitOptionsForm(&$form, &$form_state) {
parent::submitOptionsForm($form, $form_state);
switch ($form_state['section']) {
case 'menu':
$this
->setOption('menu', $form_state['values']['menu']);
// send ajax form to options page if we use it.
if ($form_state['values']['menu']['type'] == 'default tab') {
$form_state['view']
->addFormToStack('display', $this->display['id'], array(
'tab_options',
));
}
break;
case 'tab_options':
$this
->setOption('tab_options', $form_state['values']['tab_options']);
break;
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::validate().
*/
public function validate() {
$errors = parent::validate();
$menu = $this
->getOption('menu');
if (!empty($menu['type']) && $menu['type'] != 'none' && empty($menu['title'])) {
$errors[] = t('Display @display is set to use a menu but the menu link text is not set.', array(
'@display' => $this->display['display_title'],
));
}
if ($menu['type'] == 'default tab') {
$tab_options = $this
->getOption('tab_options');
if (!empty($tab_options['type']) && $tab_options['type'] != 'none' && empty($tab_options['title'])) {
$errors[] = t('Display @display is set to use a parent menu but the parent menu link text is not set.', array(
'@display' => $this->display['display_title'],
));
}
}
return $errors;
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::getArgumentText().
*/
public function getArgumentText() {
return array(
'filter value not present' => t('When the filter value is <em>NOT</em> in the URL'),
'filter value present' => t('When the filter value <em>IS</em> in the URL or a default is provided'),
'description' => t('The contextual filter values is provided by the URL.'),
);
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::getPagerText().
*/
public function getPagerText() {
return array(
'items per page title' => t('Items per page'),
'items per page description' => t('The number of items to display per page. Enter 0 for no limit.'),
);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::usesBreadcrumb(). Overrides DisplayPluginBase:: |
|
Page:: |
protected | function |
Overrides \Drupal\views\Plugin\views\display\PathPluginBase::defineOptions(). Overrides PathPluginBase:: |
|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\PathPluginBase::execute(). Overrides PathPluginBase:: |
|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary(). Overrides PathPluginBase:: |
|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\callbackPluginBase::buildOptionsForm(). Overrides PathPluginBase:: |
|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\callbackPluginBase::validateOptionsForm(). Overrides PathPluginBase:: |
|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\callbackPluginBase::submitOptionsForm(). Overrides PathPluginBase:: |
|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::validate(). Overrides DisplayPluginBase:: |
|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::getArgumentText(). Overrides DisplayPluginBase:: |
|
Page:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::getPagerText(). Overrides DisplayPluginBase:: |
|
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::hasPath(). Overrides DisplayPluginBase:: |
|
PathPluginBase:: |
public | function | Add this display's path information to Drupal's menu system. | |
DisplayPluginBase:: |
public | function | 1 | |
DisplayPluginBase:: |
public | function |
Clears a plugin. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function | Determine if this display is the 'default' display which contains fallback settings | 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 | Determine if this display should display the exposed filters widgets, so the view will know whether or not to render them. | 1 |
DisplayPluginBase:: |
public | function | Whether the display allows the use of AJAX or not. | 1 |
DisplayPluginBase:: |
public | function | Whether the display is actually using AJAX or not. | |
DisplayPluginBase:: |
public | function | Whether the display is enabled. | |
DisplayPluginBase:: |
public | function | Whether the display allows the use of a pager or not. | 2 |
DisplayPluginBase:: |
public | function | Whether the display is using a pager or not. | |
DisplayPluginBase:: |
public | function | Whether the display allows the use of a 'more' link or not. | |
DisplayPluginBase:: |
public | function | Whether the display is using the 'more' link or not. | |
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 | Determines whether this display can use attachments. | |
DisplayPluginBase:: |
public | function | Returns whether the display can use attachments. | 4 |
DisplayPluginBase:: |
public | function | Returns whether the display can use areas. | 1 |
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 | Check to see if the display has some need to link to another display. | 1 |
DisplayPluginBase:: |
public | function | Check to see if the display can put the exposed formin a block. | |
DisplayPluginBase:: |
public | function | Check to see which display to use when creating links within a view using this display. | |
DisplayPluginBase:: |
public | function | Return the base path to use for this display. | |
DisplayPluginBase:: |
public | function | ||
DisplayPluginBase:: |
public | function | Determine if a given option is set to use the default display or the current 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 | Determine if the display's style uses fields. | |
DisplayPluginBase:: |
public | function | Get the instance of a plugin, for example style or row. | |
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 | Retrieve a list of fields for the current display with the relationship associated if it exists. | |
DisplayPluginBase:: |
public | function | Intelligently set an option either from this display or from the default display, if directed to do so. | |
DisplayPluginBase:: |
public | function | Set an option and force it to be an override. | |
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 | Returns to tokens for arguments. | |
DisplayPluginBase:: |
protected | function | Format a list of theme templates for output by the theme info helper. | |
DisplayPluginBase:: |
public | function | If override/revert was clicked, perform the proper toggle. | |
DisplayPluginBase:: |
public | function | Flip the override setting for the given section. | |
DisplayPluginBase:: |
public | function |
Inject anything into the query that the display handler needs. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function | Not all display plugins will support filtering | |
DisplayPluginBase:: |
public | function | Not all display plugins will suppert pager rendering. | 1 |
DisplayPluginBase:: |
public | function | Render the 'more' link | |
DisplayPluginBase:: |
public | function | Render the header of the view. | |
DisplayPluginBase:: |
public | function | Render the footer of the view. | |
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 | Render this display. | 1 |
DisplayPluginBase:: |
public | function | ||
DisplayPluginBase:: |
public | function | Determine if the user has access to this display of the view. | |
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:: |
protected | function | Displays can require a certain type of style plugin. By default, they will be 'normal'. | 1 |
DisplayPluginBase:: |
public | function | Check if the provided identifier is unique. | |
DisplayPluginBase:: |
public | function | Provide the block system with any exposed widget blocks for this display. | |
DisplayPluginBase:: |
public | function | Render any special blocks provided for this display. | |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
PluginBase:: |
protected | function | ||
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 | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
Page:: |
protected | property |
Whether the display allows attachments. Overrides DisplayPluginBase:: |
|
DisplayPluginBase:: |
property |
The top object of a view. Overrides PluginBase:: |
||
DisplayPluginBase:: |
property | |||
DisplayPluginBase:: |
protected | property | An array of instantiated plugins used in this display. | |
DisplayPluginBase:: |
property | Stores all available display extenders. | ||
DisplayPluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | property | Stores the rendered output of the display. | |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of AJAX or not. | 1 |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of a pager or not. | 2 |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of a 'more' link or not. | |
DisplayPluginBase:: |
protected | property | Whether the display allows area plugins. | 1 |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |