You are here

class views_plugin_row in Views (for Drupal 7) 6.2

Same name and namespace in other branches
  1. 6.3 plugins/views_plugin_row.inc \views_plugin_row
  2. 7.3 plugins/views_plugin_row.inc \views_plugin_row

Default plugin to view a single row of a table. This is really just a wrapper around a theme function.

Hierarchy

Expanded class hierarchy of views_plugin_row

Related topics

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

File

plugins/views_plugin_row.inc, line 24
Contains the base row style plugin.

View source
class views_plugin_row extends views_plugin {

  /**
   * Initialize the row plugin.
   */
  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('row_options'));
  }
  function uses_fields() {
    return !empty($this->definition['uses fields']);
  }
  function option_definition() {
    $options = parent::option_definition();
    if (isset($this->base_table)) {
      $options['relationship'] = array(
        'default' => 'none',
      );
    }
    return $options;
  }

  /**
   * Provide a form for setting options.
   */
  function options_form(&$form, &$form_state) {
    if (isset($this->base_table)) {
      $view =& $form_state['view'];

      // A whole bunch of code to figure out what relationships are valid for
      // this item.
      $relationships = $view->display_handler
        ->get_option('relationships');
      $relationship_options = array();
      foreach ($relationships as $relationship) {
        $relationship_handler = views_get_handler($relationship['table'], $relationship['field'], 'relationship');

        // If this relationship is valid for this type, add it to the list.
        $data = views_fetch_data($relationship['table']);
        $base = $data[$relationship['field']]['relationship']['base'];
        if ($base == $this->base_table) {
          $relationship_handler
            ->init($view, $relationship);
          $relationship_options[$relationship['id']] = $relationship_handler
            ->label();
        }
      }
      if (!empty($relationship_options)) {
        $relationship_options = array_merge(array(
          'none' => t('Do not use a relationship'),
        ), $relationship_options);
        $rel = empty($this->options['relationship']) ? 'none' : $this->options['relationship'];
        if (empty($relationship_options[$rel])) {

          // Pick the first relationship.
          $rel = key($relationship_options);
        }
        $form['relationship'] = array(
          '#type' => 'select',
          '#title' => t('Relationship'),
          '#options' => $relationship_options,
          '#default_value' => $rel,
        );
      }
      else {
        $form['relationship'] = array(
          '#type' => 'value',
          '#value' => 'none',
        );
      }
    }
  }

  /**
   * Validate the options form.
   */
  function options_validate(&$form, &$form_state) {
  }

  /**
   * Perform any necessary changes to the form values prior to storage.
   * There is no need for this function to actually store the data.
   */
  function options_submit(&$form, &$form_state) {
  }
  function query() {
    if (isset($this->base_table) && isset($this->options['relationship']) && isset($this->view->relationship[$this->options['relationship']])) {
      $relationship = $this->view->relationship[$this->options['relationship']];
      $this->field_alias = $this->view->query
        ->add_field($relationship->alias, $this->base_field);
    }
    else {
      $this->field_alias = $this->view->base_field;
    }
  }

  /**
   * 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) {
  }

  /**
   * Render a row object. This usually passes through to a theme template
   * of some form, but not always.
   */
  function render($row) {
    return theme($this
      ->theme_functions(), $this->view, $this->options, $row, $this->field_alias);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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. 5
views_object::destroy function 2
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::_set_option_defaults function 1
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
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_row::init function Initialize the row plugin. Overrides views_plugin::init 1
views_plugin_row::options_form function Provide a form for setting options. Overrides views_plugin::options_form 6
views_plugin_row::options_submit function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_plugin::options_submit 1
views_plugin_row::options_validate function Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition 6
views_plugin_row::pre_render function Allow the style to do stuff before each row is rendered. 1
views_plugin_row::query function Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::render function Render a row object. This usually passes through to a theme template of some form, but not always. 4
views_plugin_row::uses_fields function