The base plugin to handle pager.
Expanded class hierarchy of PagerPluginBase
abstract class PagerPluginBase extends PluginBase {
var $current_page = NULL;
var $total_items = 0;
/**
* Overrides Drupal\views\Plugin\Plugin::$usesOptions.
*/
protected $usesOptions = TRUE;
/**
* Initialize the plugin.
*
* @param $view
* The view object.
* @param $display
* The display handler.
*/
public function init(ViewExecutable $view, &$display, $options = array()) {
$this
->setOptionDefaults($this->options, $this
->defineOptions());
$this->view =& $view;
$this->displayHandler =& $display;
$this
->unpackOptions($this->options, $options);
}
/**
* Get how many items per page this pager will display.
*
* All but the leanest pagers should probably return a value here, so
* most pagers will not need to override this method.
*/
function get_items_per_page() {
return isset($this->options['items_per_page']) ? $this->options['items_per_page'] : 0;
}
/**
* Set how many items per page this pager will display.
*
* This is mostly used for things that will override the value.
*/
function set_items_per_page($items) {
$this->options['items_per_page'] = $items;
}
/**
* Get the page offset, or how many items to skip.
*
* Even pagers that don't actually page can skip items at the beginning,
* so few pagers will need to override this method.
*/
function get_offset() {
return isset($this->options['offset']) ? $this->options['offset'] : 0;
}
/**
* Set the page offset, or how many items to skip.
*/
function set_offset($offset) {
$this->options['offset'] = $offset;
}
/**
* Get the current page.
*
* If NULL, we do not know what the current page is.
*/
function get_current_page() {
return $this->current_page;
}
/**
* Set the current page.
*
* @param $number
* If provided, the page number will be set to this. If NOT provided,
* the page number will be set from the global page array.
*/
function set_current_page($number = NULL) {
if (!is_numeric($number) || $number < 0) {
$number = 0;
}
$this->current_page = $number;
}
/**
* Get the total number of items.
*
* If NULL, we do not yet know what the total number of items are.
*/
function get_total_items() {
return $this->total_items;
}
/**
* Get the pager id, if it exists
*/
function get_pager_id() {
return isset($this->options['id']) ? $this->options['id'] : 0;
}
/**
* Provide the default form form for validating options
*/
public function validateOptionsForm(&$form, &$form_state) {
}
/**
* Provide the default form form for submitting options
*/
public function submitOptionsForm(&$form, &$form_state) {
}
/**
* Return a string to display as the clickable title for the
* pager plugin.
*/
public function summaryTitle() {
return t('Unknown');
}
/**
* Determine if this pager actually uses a pager.
*
* Only a couple of very specific pagers will set this to false.
*/
function use_pager() {
return TRUE;
}
/**
* Determine if a pager needs a count query.
*
* If a pager needs a count query, a simple query
*/
function use_count_query() {
return TRUE;
}
/**
* Execute the count query, which will be done just prior to the query
* itself being executed.
*/
function execute_count_query(&$count_query) {
$this->total_items = $count_query
->execute()
->fetchField();
if (!empty($this->options['offset'])) {
$this->total_items -= $this->options['offset'];
}
$this
->update_page_info();
return $this->total_items;
}
/**
* 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.
*/
function update_page_info() {
}
/**
* Modify the query for paging
*
* This is called during the build phase and can directly modify the query.
*/
public function query() {
}
/**
* Perform any needed actions just prior to the query executing.
*/
function pre_execute(&$query) {
}
/**
* Perform any needed actions just after the query executing.
*/
public function postExecute(&$result) {
}
/**
* Perform any needed actions just before rendering.
*/
function pre_render(&$result) {
}
/**
* Render the pager.
*
* Called during the view render process, this will render the
* pager.
*
* @param $input
* Any extra GET parameters that should be retained, such as exposed
* input.
*/
function render($input) {
}
/**
* Determine if there are more records available.
*
* This is primarily used to control the display of a more link.
*/
function has_more_records() {
return $this
->get_items_per_page() && $this->total_items > (intval($this->current_page) + 1) * $this
->get_items_per_page();
}
function exposed_form_alter(&$form, &$form_state) {
}
function exposed_form_validate(&$form, &$form_state) {
}
function exposed_form_submit(&$form, &$form_state, &$exclude) {
}
function uses_exposed() {
return FALSE;
}
function items_per_page_exposed() {
return FALSE;
}
function offset_exposed() {
return FALSE;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PagerPluginBase:: |
property | |||
PagerPluginBase:: |
property | |||
PagerPluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
PagerPluginBase:: |
function | Execute the count query, which will be done just prior to the query itself being executed. | 1 | |
PagerPluginBase:: |
function | 1 | ||
PagerPluginBase:: |
function | |||
PagerPluginBase:: |
function | 1 | ||
PagerPluginBase:: |
function | Get the current page. | ||
PagerPluginBase:: |
function | Get how many items per page this pager will display. | 1 | |
PagerPluginBase:: |
function | Get the page offset, or how many items to skip. | ||
PagerPluginBase:: |
function | Get the pager id, if it exists | ||
PagerPluginBase:: |
function | Get the total number of items. | ||
PagerPluginBase:: |
function | Determine if there are more records available. | ||
PagerPluginBase:: |
public | function | Initialize the plugin. | 1 |
PagerPluginBase:: |
function | 1 | ||
PagerPluginBase:: |
function | 1 | ||
PagerPluginBase:: |
public | function | Perform any needed actions just after the query executing. | 1 |
PagerPluginBase:: |
function | Perform any needed actions just prior to the query executing. | ||
PagerPluginBase:: |
function | Perform any needed actions just before rendering. | ||
PagerPluginBase:: |
public | function |
Modify the query for paging Overrides PluginBase:: |
3 |
PagerPluginBase:: |
function | Render the pager. | 1 | |
PagerPluginBase:: |
function | Set the current page. | 1 | |
PagerPluginBase:: |
function | Set how many items per page this pager will display. | ||
PagerPluginBase:: |
function | Set the page offset, or how many items to skip. | ||
PagerPluginBase:: |
public | function |
Provide the default form form for submitting options Overrides PluginBase:: |
|
PagerPluginBase:: |
public | function |
Return a string to display as the clickable title for the
pager plugin. Overrides PluginBase:: |
3 |
PagerPluginBase:: |
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:: |
function | 1 | ||
PagerPluginBase:: |
function | Determine if a pager needs a count query. | 2 | |
PagerPluginBase:: |
function | Determine if this pager actually uses a pager. | 2 | |
PagerPluginBase:: |
public | function |
Provide the default form form for validating options Overrides PluginBase:: |
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 | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Provide a form to edit options for this plugin. | 15 |
PluginBase:: |
protected | function | Information about options for all kinds of purposes will be held here. @code 'option_name' => array( | 14 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
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 | 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 | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |