Plugin for views without pagers.
@Plugin(
id = "none",
title = @Translation("Display all items"),
help = @Translation("Display all items that this view might find."),
display_types = {"basic"}
)
Expanded class hierarchy of None
class None extends PagerPluginBase {
/**
* Overrides \Drupal\views\Plugin\views\PluginBase::init().
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
// If the pager is set to none, then it should show all items.
$this
->setItemsPerPage(0);
}
public function summaryTitle() {
if (!empty($this->options['offset'])) {
return t('All items, skip @skip', array(
'@skip' => $this->options['offset'],
));
}
return t('All items');
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['offset'] = array(
'default' => 0,
);
return $options;
}
/**
* Provide the default form for setting options.
*/
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($form, $form_state);
$form['offset'] = array(
'#type' => 'textfield',
'#title' => t('Offset (number of items to skip)'),
'#description' => t('For example, set this to 3 and the first 3 items will not be displayed.'),
'#default_value' => $this->options['offset'],
);
}
public function usePager() {
return FALSE;
}
public function useCountQuery() {
return FALSE;
}
public function getItemsPerPage() {
return 0;
}
public function executeCountQuery(&$count_query) {
// If we are displaying all items, never count. But we can update the count in post_execute.
}
public function postExecute(&$result) {
$this->total_items = count($result);
}
public function query() {
// The only query modifications we might do are offsets.
if (!empty($this->options['offset'])) {
$this->view->query
->setOffset($this->options['offset']);
}
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PagerPluginBase:: |
function | Render the pager. | 2 | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PagerPluginBase:: |
public | function | Set the current page. | 1 |
PagerPluginBase:: |
public | function |
Provide the default form form for validating options Overrides PluginBase:: |
1 |
PagerPluginBase:: |
public | function | If there are pagers that need global values set, this method can be used to set them. It will be called when the count query is run. | 1 |
PagerPluginBase:: |
public | function | 1 | |
PagerPluginBase:: |
public | function | 1 | |
PagerPluginBase:: |
public | function | 1 | |
PagerPluginBase:: |
protected | function | 1 | |
PagerPluginBase:: |
protected | function | 1 | |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
None:: |
public | function |
Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase:: |
|
None:: |
public | function |
Return a string to display as the clickable title for the
pager plugin. Overrides PagerPluginBase:: |
|
None:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides PluginBase:: |
|
None:: |
public | function |
Provide the default form for setting options. Overrides PluginBase:: |
|
None:: |
public | function |
Determine if this pager actually uses a pager. Overrides PagerPluginBase:: |
|
None:: |
public | function |
Determine if a pager needs a count query. Overrides PagerPluginBase:: |
|
None:: |
public | function |
Get how many items per page this pager will display. Overrides PagerPluginBase:: |
|
None:: |
public | function |
Execute the count query, which will be done just prior to the query
itself being executed. Overrides PagerPluginBase:: |
|
None:: |
public | function |
Perform any needed actions just after the query executing. Overrides PagerPluginBase:: |
|
None:: |
public | function |
Modify the query for paging Overrides PagerPluginBase:: |
|
PagerPluginBase:: |
public | function | Set how many items per page this pager will display. | |
PagerPluginBase:: |
public | function | Get the page offset, or how many items to skip. | |
PagerPluginBase:: |
public | function | Set the page offset, or how many items to skip. | |
PagerPluginBase:: |
public | function | Get the current page. | |
PagerPluginBase:: |
public | function | Get the total number of items. | |
PagerPluginBase:: |
public | function | Get the pager id, if it exists | |
PagerPluginBase:: |
public | function |
Provide the default form form for submitting options Overrides PluginBase:: |
|
PagerPluginBase:: |
public | function | Perform any needed actions just prior to the query executing. | |
PagerPluginBase:: |
function | Perform any needed actions just before rendering. | ||
PagerPluginBase:: |
public | function | Determine if there are more records available. | |
PagerPluginBase:: |
public | function | ||
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
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 | Return the human readable name of the display. | |
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 |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PagerPluginBase:: |
property | |||
PagerPluginBase:: |
property | |||
PagerPluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
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 plugin_id. | |
PluginBase:: |
protected | property | The plugin implementation definition. |