class views_plugin_pager_some in Views (for Drupal 7) 7.3

Plugin for views without pagers.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_pager
      • class \views_plugin_pager_some

Related topics

Views pager plugins

@todo.

1 string reference to 'views_plugin_pager_some'

views_views_plugins in includes/plugins.inc

Implements hook_views_plugins().

File

plugins/views_plugin_pager_some.inc, line 13

Definition of views_plugin_pager_some.

class views_plugin_pager_some extends views_plugin_pager {

  /**
   *
   */
  public function summary_title() {
    if (!empty($this->options['offset'])) {
      return format_plural($this->options['items_per_page'], '@count item, skip @skip', '@count items, skip @skip', array(
        '@count' => $this->options['items_per_page'],
        '@skip' => $this->options['offset'],
      ));
    }
    return format_plural($this->options['items_per_page'], '@count item', '@count items', array(
      '@count' => $this->options['items_per_page'],
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['items_per_page'] = array(
      'default' => 10,
    );
    $options['offset'] = array(
      'default' => 0,
    );
    return $options;
  }

  /**
   * Provide the default form for setting options.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $pager_text = $this->display->handler
      ->get_pager_text();
    $form['items_per_page'] = array(
      '#title' => $pager_text['items per page title'],
      '#type' => 'textfield',
      '#description' => $pager_text['items per page description'],
      '#default_value' => $this->options['items_per_page'],
    );
    $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'],
    );
  }

  /**
   * {@inheritdoc}
   */
  public function use_pager() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function use_count_query() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    $this->view->query
      ->set_limit($this->options['items_per_page']);
    $this->view->query
      ->set_offset($this->options['offset']);
  }

}

Members

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