class views_plugin_style in Views (for Drupal 7) 6.3

Base class to define a style plugin handler.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_style

Related topics

Views' style plugins

Style plugins control how a view is rendered. For example, they can choose to display a collection of fields, node_view() output, table output, or any kind of crazy output they want.

1 string reference to 'views_plugin_style'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_style.inc, line 20

class views_plugin_style extends views_plugin {

  /**
   * Store all availible tokens row rows.
   */
  var $row_tokens = array();

  /**
   * Contains the row plugin, if it's initialized
   * and the style itself supports it.
   *
   * @var views_plugin_row
   */
  var $row_plugin;

  /**
   * Initialize a style plugin.
   *
   * @param $view
   * @param $display
   * @param $options
   *   The style options might come externally as the style can be sourced
   *   from at least two locations. If it's not included, look on the display.
   */
  function init(&$view, &$display, $options = NULL) {
    $this->view =& $view;
    $this->display =& $display;

    // Overlay incoming options on top of defaults
    $this
      ->unpack_options($this->options, isset($options) ? $options : $display->handler
      ->get_option('style_options'));
    if ($this
      ->uses_row_plugin() && $display->handler
      ->get_option('row_plugin')) {
      $this->row_plugin = $display->handler
        ->get_plugin('row');
    }
    $this->options += array(
      'grouping' => '',
    );
    $this->definition += array(
      'uses grouping' => TRUE,
    );
  }
  function destroy() {
    parent::destroy();
    if (isset($this->row_plugin)) {
      $this->row_plugin
        ->destroy();
    }
  }

  /**
   * Return TRUE if this style also uses a row plugin.
   */
  function uses_row_plugin() {
    return !empty($this->definition['uses row plugin']);
  }

  /**
   * Return TRUE if this style also uses a row plugin.
   */
  function uses_row_class() {
    return !empty($this->definition['uses row class']);
  }

  /**
   * Return TRUE if this style also uses fields.
   */
  function uses_fields() {

    // If we use a row plugin, ask the row plugin. Chances are, we don't
    // care, it does.
    if ($this
      ->uses_row_plugin() && !empty($this->row_plugin)) {
      return $this->row_plugin
        ->uses_fields();
    }

    // Otherwise, maybe we do.
    return !empty($this->definition['uses fields']);
  }

  /**
   * Return TRUE if this style uses tokens.
   *
   * Used to ensure we don't fetch tokens when not needed for performance.
   */
  function uses_tokens() {
    if ($this
      ->uses_row_class()) {
      $class = $this->options['row_class'];
      if (strpos($class, '[') !== FALSE || strpos($class, '!') !== FALSE || strpos($class, '%') !== FALSE) {
        return TRUE;
      }
    }
  }

  /**
   * Return the token replaced row class for the specified row.
   */
  function get_row_class($row_index) {
    if ($this
      ->uses_row_class()) {
      $class = $this->options['row_class'];
      if ($this
        ->uses_fields() && $this->view->field) {
        $class = strip_tags($this
          ->tokenize_value($class, $row_index));
      }
      return views_css_safe($class);
    }
  }

  /**
   * Take a value and apply token replacement logic to it.
   */
  function tokenize_value($value, $row_index) {
    if (strpos($value, '[') !== FALSE || strpos($value, '!') !== FALSE || strpos($value, '%') !== FALSE) {
      $fake_item = array(
        'alter_text' => TRUE,
        'text' => $value,
      );

      // Row tokens might be empty, for example for node row style.
      $tokens = isset($this->row_tokens[$row_index]) ? $this->row_tokens[$row_index] : array();
      if (!empty($this->view->build_info['substitutions'])) {
        $tokens += $this->view->build_info['substitutions'];
      }
      if ($tokens) {
        $value = strtr($value, $tokens);
      }
    }
    return $value;
  }

  /**
   * Should the output of the style plugin be rendered even if it's a empty view.
   */
  function even_empty() {
    return !empty($this->definition['even empty']);
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['grouping'] = array(
      'default' => '',
    );
    if ($this
      ->uses_row_class()) {
      $options['row_class'] = array(
        'default' => '',
      );
    }
    return $options;
  }
  function options_form(&$form, &$form_state) {

    // Only fields-based views can handle grouping.  Style plugins can also exclude
    // themselves from being groupable by setting their "use grouping" definiton
    // key to FALSE.
    // @TODO: Document "uses grouping" in docs.php when docs.php is written.
    if ($this
      ->uses_fields() && $this->definition['uses grouping']) {
      $options = array(
        '' => t('- None -'),
      );
      $options += $this->display->handler
        ->get_field_labels();

      // If there are no fields, we can't group on them.
      if (count($options) > 1) {
        $form['grouping'] = array(
          '#type' => 'select',
          '#title' => t('Grouping field'),
          '#options' => $options,
          '#default_value' => $this->options['grouping'],
          '#description' => t('You may optionally specify a field by which to group the records. Leave blank to not group.'),
        );
      }
    }
    if ($this
      ->uses_row_class()) {
      $form['row_class'] = array(
        '#title' => t('Row class'),
        '#description' => t('The class to provide on each row.'),
        '#type' => 'textfield',
        '#default_value' => $this->options['row_class'],
      );
      if ($this
        ->uses_fields()) {
        $form['row_class']['#description'] .= ' ' . t('You may use field tokens from as per the "Replacement patterns" used in "Rewrite the output of this field" for all fields.');
      }
    }
  }

  /**
   * 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.
   */
  function build_sort() {
    return TRUE;
  }

  /**
   * 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.
   */
  function build_sort_post() {
  }

  /**
   * Allow the style to do stuff before each row is rendered.
   *
   * @param $result
   *   The full array of results from the query.
   */
  function pre_render($result) {
    if (!empty($this->row_plugin)) {
      $this->row_plugin
        ->pre_render($result);
    }
  }

  /**
   * Render the display in this style.
   */
  function render() {
    if ($this
      ->uses_row_plugin() && empty($this->row_plugin)) {
      vpr('views_plugin_style_default: Missing row plugin');
      return;
    }

    // Group the rows according to the grouping field, if specified.
    $sets = $this
      ->render_grouping($this->view->result, $this->options['grouping']);

    // Render each group separately and concatenate.  Plugins may override this
    // method if they wish some other way of handling grouping.
    $output = '';
    foreach ($sets as $title => $records) {
      if ($this
        ->uses_row_plugin()) {
        $rows = array();
        foreach ($records as $row_index => $row) {
          $this->view->row_index = $row_index;
          $rows[$row_index] = $this->row_plugin
            ->render($row);
        }
      }
      else {
        $rows = $records;
      }
      $output .= theme($this
        ->theme_functions(), $this->view, $this->options, $rows, $title);
    }
    unset($this->view->row_index);
    return $output;
  }

  /**
   * Group records as needed for rendering.
   *
   * @param $records
   *   An array of records from the view to group.
   * @param $grouping_field
   *   The field id on which to group.  If empty, the result set will be given
   *   a single group with an empty string as a label.
   * @return
   *   The grouped record set.
   */
  function render_grouping($records, $grouping_field = '') {

    // Make sure fields are rendered
    $this
      ->render_fields($this->view->result);
    $sets = array();
    if ($grouping_field) {
      foreach ($records as $index => $row) {
        $grouping = '';

        // Group on the rendered version of the field, not the raw.  That way,
        // we can control any special formatting of the grouping field through
        // the admin or theme layer or anywhere else we'd like.
        if (isset($this->view->field[$grouping_field])) {
          $grouping = $this
            ->get_field($index, $grouping_field);
          if ($this->view->field[$grouping_field]->options['label']) {
            $grouping = $this->view->field[$grouping_field]->options['label'] . ': ' . $grouping;
          }
        }
        $sets[$grouping][$index] = $row;
      }
    }
    else {

      // Create a single group with an empty grouping field.
      $sets[''] = $records;
    }
    return $sets;
  }

  /**
   * Render all of the fields for a given style and store them on the object.
   *
   * @param $result
   *   The result array from $view->result
   */
  function render_fields($result) {
    if (!$this
      ->uses_fields()) {
      return;
    }
    if (!isset($this->rendered_fields)) {
      $this->rendered_fields = array();
      $this->view->row_index = 0;
      $keys = array_keys($this->view->field);

      // If all fields have a field::access FALSE there might be no fields, so
      // there is no reason to execute this code.
      if (!empty($keys)) {
        foreach ($result as $count => $row) {
          $this->view->row_index = $count;
          foreach ($keys as $id) {
            $this->rendered_fields[$count][$id] = $this->view->field[$id]
              ->theme($row);
          }
          $this->row_tokens[$count] = $this->view->field[$id]
            ->get_render_tokens(array());
        }
      }
      unset($this->view->row_index);
    }
    return $this->rendered_fields;
  }

  /**
   * Get a rendered field.
   *
   * @param $index
   *   The index count of the row.
   * @param $field
   *    The id of the field.
   */
  function get_field($index, $field) {
    if (!isset($this->rendered_fields)) {
      $this
        ->render_fields($this->view->result);
    }
    if (isset($this->rendered_fields[$index][$field])) {
      return $this->rendered_fields[$index][$field];
    }
  }
  function validate() {
    $errors = parent::validate();
    if ($this
      ->uses_row_plugin()) {
      $plugin = $this->display->handler
        ->get_plugin('row');
      if (empty($plugin)) {
        $errors[] = t('Style @style requires a row style but the row plugin is invalid.', array(
          '@style' => $this->definition['title'],
        ));
      }
      else {
        $result = $plugin
          ->validate();
        if (!empty($result) && is_array($result)) {
          $errors = array_merge($errors, $result);
        }
      }
    }
    return $errors;
  }
  function query() {
    parent::query();
    if (isset($this->row_plugin)) {
      $this->row_plugin
        ->query();
    }
  }

}

Members

Name	Modifiers	Type	Description	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::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::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_submit		function	Handle any special handling on the validate form.	9
views_plugin::options_validate		function	Validate the options form.	8
views_plugin::theme_functions		function	Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin		property	Contains the row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens		property	Store all availible tokens row rows.
views_plugin_style::build_sort		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		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		function	Overrides views_object::destroy
views_plugin_style::even_empty		function	Should the output of the style plugin be rendered even if it's a empty view.	1
views_plugin_style::get_field		function	Get a rendered field.
views_plugin_style::get_row_class		function	Return the token replaced row class for the specified row.
views_plugin_style::init		function	Initialize a style plugin.
views_plugin_style::options_form		function	Provide a form to edit options for this plugin. Overrides views_plugin::options_form	8
views_plugin_style::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition	7
views_plugin_style::pre_render		function	Allow the style to do stuff before each row is rendered.
views_plugin_style::query		function	Add anything to the query that we might need to. Overrides views_plugin::query	2
views_plugin_style::render		function	Render the display in this style.	4
views_plugin_style::render_fields		function	Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping		function	Group records as needed for rendering.
views_plugin_style::tokenize_value		function	Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields		function	Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class		function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin		function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens		function	Return TRUE if this style uses tokens.
views_plugin_style::validate		function	Validate that the plugin is correct and can be saved. Overrides views_plugin::validate