class views_plugin_pager

Same name in other branches
  1. 7.x-3.x plugins/views_plugin_pager.inc \views_plugin_pager

The base plugin to handle pager.

Hierarchy

Expanded class hierarchy of views_plugin_pager

1 string reference to 'views_plugin_pager'
views_views_plugins in includes/plugins.inc
Implementation of hook_views_plugins

File

plugins/views_plugin_pager.inc, line 8

View source
class views_plugin_pager extends views_plugin {
    var $current_page = NULL;
    var $total_items = 0;
    
    /**
     * Initialize the plugin.
     *
     * @param $view
     *   The view object.
     * @param $display
     *   The display handler.
     */
    function init(&$view, &$display, $options = array()) {
        $this->view =& $view;
        $this->display =& $display;
        $this->unpack_options($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) {
        $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
     */
    function options_validate(&$form, &$form_state) {
    }
    
    /**
     * Provide the default form form for submitting options
     */
    function options_submit($form, &$form_state) {
    }
    
    /**
     * Return a string to display as the clickable title for the
     * pager plugin.
     */
    function summary_title() {
        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, $args) {
        $query_plugin = $this->view->query;
        $this->total_items = $query_plugin->db_result($query_plugin->db_query($count_query, $args));
        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.
     */
    function query() {
    }
    
    /**
     * Perform any needed actions just prior to the query executing.
     */
    function pre_execute(&$query, &$args) {
    }
    
    /**
     * Perform any needed actions just after the query executing.
     */
    function post_execute(&$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;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
views_object::$definition property Handler's definition
views_object::$options property Except for displays, options for the object will be held here. 1
views_object::construct function Views handlers use a special construct function so that we can more
easily construct them with variable arguments.
6
views_object::destroy function 2
views_object::export_option function 1
views_object::export_options function
views_object::options function Set default options on this object. Called by the constructor in a
complex chain to deal with backward compatibility.
1
views_object::option_definition function Information about options for all kinds of purposes will be held here. 13
views_object::set_default_options 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::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function
views_plugin::$display property The current used views display.
views_plugin::$plugin_type property The plugin type of this plugin, for example style or query.
views_plugin::$view property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::options_form function Provide a form to edit options for this plugin. 13
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin::validate function Validate that the plugin is correct and can be saved. 2
views_plugin_pager::$current_page property
views_plugin_pager::$total_items property
views_plugin_pager::execute_count_query function Execute the count query, which will be done just prior to the query
itself being executed.
1
views_plugin_pager::exposed_form_alter function 1
views_plugin_pager::exposed_form_submit function
views_plugin_pager::exposed_form_validate function 1
views_plugin_pager::get_current_page function Get the current page.
views_plugin_pager::get_items_per_page function Get how many items per page this pager will display. 1
views_plugin_pager::get_offset function Get the page offset, or how many items to skip.
views_plugin_pager::get_pager_id function Get the pager id, if it exists
views_plugin_pager::get_total_items function Get the total number of items.
views_plugin_pager::has_more_records function Determine if there are more records available.
views_plugin_pager::init function Initialize the plugin. 1
views_plugin_pager::items_per_page_exposed function 1
views_plugin_pager::offset_exposed function 1
views_plugin_pager::options_submit function Provide the default form form for submitting options Overrides views_plugin::options_submit
views_plugin_pager::options_validate function Provide the default form form for validating options Overrides views_plugin::options_validate 1
views_plugin_pager::post_execute function Perform any needed actions just after the query executing. 1
views_plugin_pager::pre_execute function Perform any needed actions just prior to the query executing.
views_plugin_pager::pre_render function Perform any needed actions just before rendering.
views_plugin_pager::query function Modify the query for paging Overrides views_plugin::query 3
views_plugin_pager::render function Render the pager. 1
views_plugin_pager::set_current_page function Set the current page. 1
views_plugin_pager::set_items_per_page function Set how many items per page this pager will display.
views_plugin_pager::set_offset function Set the page offset, or how many items to skip.
views_plugin_pager::summary_title function Return a string to display as the clickable title for the
pager plugin.
3
views_plugin_pager::update_page_info 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
views_plugin_pager::uses_exposed function 1
views_plugin_pager::use_count_query function Determine if a pager needs a count query. 2
views_plugin_pager::use_pager function Determine if this pager actually uses a pager. 2