class views_plugin_pager_mini
The plugin to handle mini pager.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_pager
- class \views_plugin_pager_full
- class \views_plugin_pager_mini
- class \views_plugin_pager_full
- class \views_plugin_pager
- class \views_plugin
Expanded class hierarchy of views_plugin_pager_mini
Related topics
1 string reference to 'views_plugin_pager_mini'
- views_views_plugins in includes/
plugins.inc - Implements hook_views_plugins().
File
- plugins/
views_plugin_pager_mini.inc, line 13 - Definition of views_plugin_pager_mini.
View source
class views_plugin_pager_mini extends views_plugin_pager_full {
function summary_title() {
if (!empty($this->options['offset'])) {
return format_plural($this->options['items_per_page'], 'Mini pager, @count item, skip @skip', 'Mini pager, @count items, skip @skip', array('@count' => $this->options['items_per_page'], '@skip' => $this->options['offset']));
}
return format_plural($this->options['items_per_page'], 'Mini pager, @count item', 'Mini pager, @count items', array('@count' => $this->options['items_per_page']));
}
/**
* Overrides views_plugin_pager_full::option_definition().
*
* Overrides the full pager options form by deleting unused settings.
*/
function option_definition() {
$options = parent::option_definition();
unset($options['quantity']);
unset($options['tags']['first']);
unset($options['tags']['last']);
$options['tags']['previous']['default'] = '‹‹';
$options['tags']['next']['default'] = '››';
return $options;
}
/**
* Overrides views_plugin_pager_full::options_form().
*
* Overrides the full pager options form by deleting unused settings.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
unset($form['quantity']);
unset($form['tags']['first']);
unset($form['tags']['last']);
}
/**
* Overrides views_plugin_pager_full::render().
*
* Overrides the full pager renderer by changing the theme function
* and leaving out variables that are not used in the mini pager.
*/
function render($input) {
$pager_theme = views_theme_functions('views_mini_pager', $this->view, $this->display);
// The 1, 3 index are correct.
// @see theme_pager().
$tags = array(
1 => $this->options['tags']['previous'],
3 => $this->options['tags']['next'],
);
return theme($pager_theme, array(
'tags' => $tags,
'element' => $this->get_pager_id(),
'parameters' => $input,
));
}
}
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 | Execute the count query, which will be done just prior to the query itself being executed. | |
views_plugin_pager:: |
function | ||
views_plugin_pager:: |
function | Get the current page. | |
views_plugin_pager:: |
function | Get how many items per page this pager will display. | |
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 | Initialize the plugin. | |
views_plugin_pager:: |
function |
Provide the default form form for submitting options Overrides views_plugin:: |
|
views_plugin_pager:: |
function | Perform any needed actions just after the query executing. | |
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 | 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 | Determine if a pager needs a count query. | |
views_plugin_pager:: |
function | Determine if this pager actually uses a pager. | |
views_plugin_pager_full:: |
function |
Overrides views_plugin_pager:: |
|
views_plugin_pager_full:: |
function |
Overrides views_plugin_pager:: |
|
views_plugin_pager_full:: |
function | ||
views_plugin_pager_full:: |
function |
Overrides views_plugin_pager:: |
|
views_plugin_pager_full:: |
function |
Overrides views_plugin_pager:: |
|
views_plugin_pager_full:: |
function |
Provide the default form form for validating options Overrides views_plugin_pager:: |
|
views_plugin_pager_full:: |
function |
Modify the query for paging Overrides views_plugin_pager:: |
|
views_plugin_pager_full:: |
function |
Set the current page. Overrides views_plugin_pager:: |
|
views_plugin_pager_full:: |
function |
Update global paging info. Overrides views_plugin_pager:: |
|
views_plugin_pager_full:: |
function |
Overrides views_plugin_pager:: |
|
views_plugin_pager_mini:: |
function |
Overrides views_plugin_pager_full::options_form(). Overrides views_plugin_pager_full:: |
|
views_plugin_pager_mini:: |
function |
Overrides views_plugin_pager_full::option_definition(). Overrides views_plugin_pager_full:: |
|
views_plugin_pager_mini:: |
function |
Overrides views_plugin_pager_full::render(). Overrides views_plugin_pager_full:: |
|
views_plugin_pager_mini:: |
function |
Return a string to display as the clickable title for the
pager plugin. Overrides views_plugin_pager_full:: |