class views_plugin_pager_none
Plugin for views without pagers.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_pager
- class \views_plugin_pager_none
- class \views_plugin_pager
- class \views_plugin
Expanded class hierarchy of views_plugin_pager_none
Related topics
1 string reference to 'views_plugin_pager_none'
- views_views_plugins in includes/
plugins.inc - Implements hook_views_plugins().
File
- plugins/
views_plugin_pager_none.inc, line 13 - Definition of views_plugin_pager_none.
View source
class views_plugin_pager_none extends views_plugin_pager {
function init(&$view, &$display, $options = array()) {
parent::init($view, $display, $options);
// If the pager is set to none, then it should show all items.
$this->set_items_per_page(0);
}
function summary_title() {
if (!empty($this->options['offset'])) {
return t('All items, skip @skip', array('@skip' => $this->options['offset']));
}
return t('All items');
}
function option_definition() {
$options = parent::option_definition();
$options['offset'] = array('default' => 0);
return $options;
}
/**
* Provide the default form for setting options.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['offset'] = array(
'#type' => 'textfield',
'#title' => t('Offset'),
'#description' => t('The number of items to skip. For example, if this field is 3, the first 3 items will be skipped and not displayed.'),
'#default_value' => $this->options['offset'],
);
}
function use_pager() {
return FALSE;
}
function use_count_query() {
return FALSE;
}
function get_items_per_page() {
return 0;
}
function execute_count_query(&$count_query) {
// If we are displaying all items, never count. But we can update the count in post_execute.
}
function post_execute(&$result) {
$this->total_items = count($result);
}
function query() {
// The only query modifications we might do are offsets.
if (!empty($this->options['offset'])) {
$this->view->query->set_offset($this->options['offset']);
}
}
}
Members
Name![]() |
Modifiers | Type | Description |
---|---|---|---|
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
function | Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point. | |
views_object:: |
function | Let the handler know what its full definition is. | |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Unpack a single option definition. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function | ||
views_plugin:: |
function | Provide a list of additional theme functions for the theme information page | |
views_plugin:: |
function | Return the human readable name of the display. | |
views_plugin:: |
function | Provide a full list of possible theme templates used by this style. | |
views_plugin:: |
function | Validate that the plugin is correct and can be saved. | |
views_plugin_pager:: |
function | ||
views_plugin_pager:: |
function | ||
views_plugin_pager:: |
function | ||
views_plugin_pager:: |
function | Get the current page. | |
views_plugin_pager:: |
function | Get the page offset, or how many items to skip. | |
views_plugin_pager:: |
function | Get the pager id, if it exists | |
views_plugin_pager:: |
function | Get the total number of items. | |
views_plugin_pager:: |
function | Determine if there are more records available. | |
views_plugin_pager:: |
function | ||
views_plugin_pager:: |
function | ||
views_plugin_pager:: |
function |
Provide the default form form for submitting options Overrides views_plugin:: |
|
views_plugin_pager:: |
function |
Provide the default form form for validating options Overrides views_plugin:: |
|
views_plugin_pager:: |
function | Perform any needed actions just prior to the query executing. | |
views_plugin_pager:: |
function | Perform any needed actions just before rendering. | |
views_plugin_pager:: |
function | Render the pager. | |
views_plugin_pager:: |
function | Set the current page. | |
views_plugin_pager:: |
function | Set how many items per page this pager will display. | |
views_plugin_pager:: |
function | Set the page offset, or how many items to skip. | |
views_plugin_pager:: |
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. | |
views_plugin_pager:: |
function | ||
views_plugin_pager_none:: |
function |
Execute the count query, which will be done just prior to the query
itself being executed. Overrides views_plugin_pager:: |
|
views_plugin_pager_none:: |
function |
Get how many items per page this pager will display. Overrides views_plugin_pager:: |
|
views_plugin_pager_none:: |
function |
Initialize the plugin. Overrides views_plugin_pager:: |
|
views_plugin_pager_none:: |
function |
Provide the default form for setting options. Overrides views_plugin:: |
|
views_plugin_pager_none:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_object:: |
|
views_plugin_pager_none:: |
function |
Perform any needed actions just after the query executing. Overrides views_plugin_pager:: |
|
views_plugin_pager_none:: |
function |
Modify the query for paging Overrides views_plugin_pager:: |
|
views_plugin_pager_none:: |
function |
Return a string to display as the clickable title for the
pager plugin. Overrides views_plugin_pager:: |
|
views_plugin_pager_none:: |
function |
Determine if a pager needs a count query. Overrides views_plugin_pager:: |
|
views_plugin_pager_none:: |
function |
Determine if this pager actually uses a pager. Overrides views_plugin_pager:: |