class EntityPagerViewsPluginStyle in Entity Pager 7

Style plugin to render each item as a row in a table.

Hierarchy

class \views_object
- class \views_plugin
  - class \views_plugin_style
    class \EntityPagerViewsPluginStyle

Expanded class hierarchy of EntityPagerViewsPluginStyle

1 string reference to 'EntityPagerViewsPluginStyle'

entity_pager_views_plugins in views/entity_pager.views.inc: Implements hook_views_plugins().

File

views/plugins/EntityPagerViewsPluginStyle.inc, line 13: Contains the Entity Pager style plugin.

View source

class EntityPagerViewsPluginStyle extends views_plugin_style {

  /**
   * Render the display in this style.
   */
  public function render() {
    if ($this
      ->uses_row_plugin() && empty($this->row_plugin)) {
      debug('views_plugin_style_default: Missing row plugin');
      return;
    }
    $pager = new EntityPagerOut($this->view);
    if ($links = $pager
      ->getEntityPager()) {

      // Only show if it has contents.
      $variables = array(
        'links' => $links,
        'count_word' => $pager
          ->getCountWord(),
      );
      return theme('entity_pager', $variables);
    }
  }

  /**
   * Options form in Views for Entity Pager.
   *
   * @param array $form
   *   Nested array of form elements that comprise the form.
   * @param array $form_state
   *   A keyed array containing the current state of the form.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $default = new EntityPager();

    // Setup an options form.
    $form['next_prev'] = array(
      '#type' => 'fieldset',
      '#title' => t('Next Previous links'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#group' => 'next_prev',
      '#weight' => 0,
    );
    $form['next_prev']['link_next'] = array(
      '#title' => t('Next label'),
      '#description' => t('The text to display for the Next link. HTML is allowed.'),
      '#type' => 'textfield',
      '#default_value' => isset($this->options['next_prev']['link_next']) ? $this->options['next_prev']['link_next'] : $default
        ->getDefault('link_next'),
    );
    $form['next_prev']['link_prev'] = array(
      '#title' => t('Previous label'),
      '#description' => t('The text to display for the Previous link. HTML is allowed.'),
      '#type' => 'textfield',
      '#default_value' => isset($this->options['next_prev']['link_prev']) ? $this->options['next_prev']['link_prev'] : $default
        ->getDefault('link_prev'),
    );
    $form['next_prev']['link_all_url'] = array(
      '#title' => t('List All URL'),
      '#description' => t('The <strong>URL</strong> of the listing Link.<br>
          Examples include:
          <ul>
              <li>the URL of a Views listing page of the Entities.</li>
              <li><strong>@front</strong> for the <strong>homepage</strong></li>
              <li>a <a href="/admin/help/token"><strong>Token</strong></a> that
              relates to the Entity.  e.g. [node:edit-url]</li>
              <li>The token can also be an <strong>entity reference</strong> if the entity
              has one.  e.g. [node:field_company]</li>
          </ul>', array(
        '@front' => '<front>',
      )),
      '#type' => 'textfield',
      '#default_value' => isset($this->options['next_prev']['link_all_url']) ? $this->options['next_prev']['link_all_url'] : $default
        ->getDefault('link_all_url'),
    );
    $form['next_prev']['link_all_text'] = array(
      '#title' => t('List All label'),
      '#description' => t("The <strong>text</strong>\n          to display for the <strong>List All URL.\n          </strong>\n          <ul>\n              <li>When an <strong>entity reference</strong> is used in\n              the <strong>List All URL</strong> box above, just add the same\n              entity reference in this box and the referenced\n              <strong>Entity Title</strong> will automatically be displayed.\n              </li>\n              <li>HTML is allowed.</li>\n          </ul>"),
      '#type' => 'textfield',
      '#default_value' => isset($this->options['next_prev']['link_all_text']) ? $this->options['next_prev']['link_all_text'] : $default
        ->getDefault('link_all_text'),
    );
    $form['next_prev']['display_count'] = array(
      '#title' => t('Display count'),
      '#description' => t('Display the number of records e.g. 5 of 8'),
      '#type' => 'checkbox',
      '#default_value' => isset($this->options['next_prev']['display_count']) ? $this->options['next_prev']['display_count'] : $default
        ->getDefault('display_count'),
      '#weight' => 10,
    );
    $form['next_prev']['log_performance'] = array(
      '#title' => t('Log performance suggestions'),
      '#description' => t('Log performance suggestions to Watchdog, see: Reports > Recent Log Messages.'),
      '#type' => 'checkbox',
      '#default_value' => isset($this->options['next_prev']['log_performance']) ? $this->options['next_prev']['log_performance'] : $default
        ->getDefault('log_performance'),
      '#weight' => 20,
    );
    $form['spacer_one'] = array(
      '#markup' => '&nbsp;',
    );

    // Remove unwanted inherited form elements.
    $form['grouping'] = '';
    if ($this
      ->uses_fields()) {
      $form['row_class'] = '';
    }
    $form['default_row_class'] = '';
    $form['row_class_special'] = '';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityPagerViewsPluginStyle::options_form	public	function	Options form in Views for Entity Pager. Overrides views_plugin_style::options_form
EntityPagerViewsPluginStyle::render	public	function	Render the display in this style. Overrides views_plugin_style::render
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::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::options_submit	public	function	Handle any special handling on the validate form.	9
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin	public	property	The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens	public	property	Store all available tokens row rows.
views_plugin_style::build_sort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
views_plugin_style::build_sort_post	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
views_plugin_style::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_style::even_empty	public	function	Should the output of the style plugin be rendered even if it's empty.	1
views_plugin_style::get_field	public	function	Get a rendered field.
views_plugin_style::get_field_value	public	function	Get the raw field value.
views_plugin_style::get_row_class	public	function	Return the token replaced row class for the specified row.
views_plugin_style::init	public	function	Initialize a style plugin.
views_plugin_style::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::option_definition	public	function	Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition	8
views_plugin_style::pre_render	public	function	Allow the style to do stuff before each row is rendered.
views_plugin_style::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query	2
views_plugin_style::render_fields	public	function	Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping	public	function	Group records as needed for rendering.
views_plugin_style::render_grouping_sets	public	function	Render the grouping sets.
views_plugin_style::tokenize_value	public	function	Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields	public	function	Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens	public	function	Return TRUE if this style uses tokens.
views_plugin_style::validate	public	function	Validate that the plugin is correct and can be saved. Overrides views_plugin::validate

You are here

class EntityPagerViewsPluginStyle in Entity Pager 7

Hierarchy

File

Members

API Navigation