You are here

Home » API reference » Matrix field 7.2 » views_handler_field_field_matrix.inc

class matrix_handler_field_field in Matrix field 7.2

Same name and namespace in other branches
  1. 8.2 views/views_handler_field_field_matrix.inc \matrix_handler_field_field

A field that displays fields.

Hierarchy

Expanded class hierarchy of matrix_handler_field_field

1 string reference to 'matrix_handler_field_field'
matrix_field_views_data_alter in views/matrix.views.inc
Implements hook_field_views_data_alter().

File

views/views_handler_field_field_matrix.inc, line 10
Matrix field handler for views.

View source 
class matrix_handler_field_field extends views_handler_field_field {
  function row_list() {
    $field = $this->field_info;
    $output = array(
      t('None'),
    );
    if ($field['type'] == 'matrix_custom') {
      $settings = unserialize($field['settings']['settings']);
      foreach ($settings['rows'] as $row_id => $row) {
        $output[$row_id] = t('@title (Row @i)', array(
          '@title' => $row['title'],
          '@i' => $row_id,
        ));
      }

      // The settings don't always come out in row order so we sort preserving
      // keys.
      ksort($output);
    }
    else {
      $output = drupal_map_assoc(range(1, $field['settings']['rows_count']));
    }
    return $output;
  }
  function col_list() {
    $field = $this->field_info;
    $output = array(
      t('None'),
    );
    if ($field['type'] == 'matrix_custom') {
      $settings = unserialize($field['settings']['settings']);
      foreach ($settings['cols'] as $col_id => $col) {
        $output[$col_id] = t('@title (Col @i)', array(
          '@title' => $col['title'],
          '@i' => $col_id,
        ));
      }

      // The settings don't always come out in row order so we sort preserving
      // keys.
      ksort($output);
    }
    else {
      $output = drupal_map_assoc(range(1, $field['settings']['cols_count']));
    }
    return $output;
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['row'] = array(
      'default' => 0,
    );
    $options['col'] = array(
      'default' => 0,
    );
    $options['show_row_headers'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    $options['show_col_headers'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    unset($form['delta']);
    $form['message'] = array(
      '#type' => 'markup',
      '#markup' => '<p>' . t('To only show one value (rather than the entire matrix) choose the cell below.') . '</p>',
    );
    $form['row'] = array(
      '#title' => t('Row'),
      '#type' => 'select',
      '#options' => $this
        ->row_list(),
      '#default_value' => $this->options['row'],
      '#description' => t('The row to select the data from'),
    );
    $form['show_row_headers'] = array(
      '#type' => 'checkbox',
      '#title' => t("Output the table's header row labels?"),
      '#default_value' => $this->options['show_row_headers'],
    );
    $form['col'] = array(
      '#title' => t('Column'),
      '#type' => 'select',
      '#options' => $this
        ->col_list(),
      '#default_value' => $this->options['col'],
      '#description' => t('The col to select the data from'),
    );
    $form['show_col_headers'] = array(
      '#type' => 'checkbox',
      '#title' => t("Output the table's left column labels?"),
      '#default_value' => $this->options['show_col_headers'],
    );
  }

  /**
   * Render all or part of the matrix according to the settings.
   *
   * Matrix bundles the entire table into the first item/delta slot so this
   * function only get's called once and is passed a render array.
   *
   * Assuming you use the default formatter of course! Alternative formatters
   * aren't going to work here. So beware!
   */
  function render_item($count, $item) {
    $element = $item['rendered'];
    if ($this->options['row']) {
      foreach ($element['#rows'] as $x => $row) {
        if ($x != $this->options['row']) {
          unset($element['#rows'][$x]);
        }
      }
    }
    if ($this->options['col']) {
      foreach ($element['#rows'] as $x => $row) {
        foreach ($row as $y => $col) {
          if ($y && $y != $this->options['col']) {
            unset($element['#rows'][$x][$y]);
          }
        }
      }
      foreach ($element['#header'] as $y => $header) {
        if ($y && $y != $this->options['col']) {
          unset($element['#header'][$y]);
        }
      }
    }
    if (!$this->options['show_col_headers']) {
      foreach ($element['#rows'] as $x => $row) {
        unset($element['#rows'][$x][0]);
      }
    }
    if (!$this->options['show_row_headers']) {
      $element['#header'] = array();
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
matrix_handler_field_field::col_list function
matrix_handler_field_field::options_form function Default options form provides the label widget that all fields should have. Overrides views_handler_field_field::options_form
matrix_handler_field_field::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_field_field::option_definition
matrix_handler_field_field::render_item function Render all or part of the matrix according to the settings. Overrides views_handler_field_field::render_item
matrix_handler_field_field::row_list function
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::can_expose public function Determine if a handler can be exposed. 2
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_form public function Form for exposed handler options. 2
views_handler::expose_options public function Set new exposed option defaults when exposed setting is flipped on. 2
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::options_validate public function Validate the options form. 4
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button public function Shortcut to display the expose/hide button. 2
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_field::$additional_fields public property Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases public property
views_handler_field::$field_alias public property
views_handler_field::$last_render_index protected property Keeps track of the last render index.
views_handler_field::$original_value public property The field value prior to any rewriting.
views_handler_field::add_additional_fields public function Add 'additional' fields to the query.
views_handler_field::admin_summary public function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render public function Render a field using advanced settings.
views_handler_field::allow_advanced_render public function Determine if this field can allow advanced rendering. 1
views_handler_field::construct public function Construct a new field handler. Overrides views_object::construct 17
views_handler_field::element_classes public function Return the class of the field.
views_handler_field::element_label_classes public function Return the class of the field's label.
views_handler_field::element_label_type public function Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type public function Return an HTML element based upon the field's element type. 2
views_handler_field::element_wrapper_classes public function Return the class of the field's wrapper.
views_handler_field::element_wrapper_type public function Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements public function Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens public function Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive public function Recursive function to add replacements for nested query string parameters.
views_handler_field::is_value_empty public function Checks if a field value is empty.
views_handler_field::label public function Get this field's label.
views_handler_field::options_submit public function Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit 1
views_handler_field::pre_render public function Run before any fields are rendered. 8
views_handler_field::render public function Render the field. 42
views_handler_field::render_altered public function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link public function Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text public function Perform an advanced text render for the item.
views_handler_field::render_trim_text public function Trim the field down to the specified length.
views_handler_field::theme public function Call out to the theme() function.
views_handler_field::theme_functions public function Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value public function Replace a value with tokens from the last field.
views_handler_field::ui_name public function Return a string representing this handler's name in the UI. Overrides views_handler::ui_name 1
views_handler_field::use_string_group_by public function Determines if this field will be available as an option to group the result by in the style settings.
views_handler_field_field::$base_table public property A shortcut for $view->base_table.
views_handler_field_field::$field_info public property Store the field information.
views_handler_field_field::$instance public property Store the field instance.
views_handler_field_field::$items public property An array to store field renderable arrays for use by render_items.
views_handler_field_field::$limit_values public property Does the rendered fields get limited.
views_handler_field_field::$multiple public property Does the field supports multiple field values.
views_handler_field_field::access public function Check whether current user has access to this handler. Overrides views_handler::access
views_handler_field_field::add_field_table public function Determine if the field table should be added to the query.
views_handler_field_field::add_self_tokens public function Add any special tokens this field might use for itself. Overrides views_handler_field::add_self_tokens
views_handler_field_field::click_sort public function Called to determine what to tell the clicksorter. Overrides views_handler_field::click_sort
views_handler_field_field::click_sortable public function Determine if this field is click sortable. Overrides views_handler_field::click_sortable
views_handler_field_field::document_self_tokens public function Document any special tokens this field might use for itself. Overrides views_handler_field::document_self_tokens
views_handler_field_field::field_language public function Return the language code of the language the field should be displayed in, according to the settings.
views_handler_field_field::get_base_table public function Set the base_table and base_table_alias.
views_handler_field_field::get_items public function
views_handler_field_field::get_value public function Get the value that's supposed to be rendered. Overrides views_handler_field::get_value
views_handler_field_field::groupby_form public function Extend the groupby form with group columns. Overrides views_handler::groupby_form
views_handler_field_field::groupby_form_submit public 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_handler::groupby_form_submit
views_handler_field_field::init public function Init the handler with necessary data. Overrides views_handler_field::init
views_handler_field_field::multiple_options_form public function Provide options for multiple value fields.
views_handler_field_field::post_execute public function Load the entities for all fields that are about to be displayed. Overrides views_handler::post_execute
views_handler_field_field::query public function Called to add the field to a query. Overrides views_handler_field::query
views_handler_field_field::render_items public function Render all items in this field together.
views_handler_field_field::set_items public function Return an array of items for the field.
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::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