class field_extractor_handler_field in Field Extractor 7

Field extractor views field.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \views_handler_field_prerender_list
    class \field_extractor_handler_field

Expanded class hierarchy of field_extractor_handler_field

1 string reference to 'field_extractor_handler_field'

field_extractor_views_data_alter in views/field_extractor.views.inc: Implements hook_views_data_alter().

File

views/field_extractor_handler_field.inc, line 6

View source

class field_extractor_handler_field extends views_handler_field_prerender_list {

  /**
   * Stores the entity type that contains the reference field.
   */
  public $entity_type;

  /**
   * Stores all entites which reference entities used for extracting.
   */
  public $entities;

  /**
   * Stores all entites used for extracting.
   */
  public $referenced_entities;

  /**
   * Stores the settings relevant to the reference field (entity type it is
   * referencing, allowed bundles, name of the column that stores the ids).
   */
  public $settings;
  public function init(&$view, &$options) {
    parent::init($view, $options);

    // Get the field, construct a fake instance array, get the settings.
    $field = field_info_field($this->definition['field_name']);
    $instance = array(
      'settings' => array(),
    );
    $this->settings = field_extractor_settings($field, $instance);

    // Initialize the entity-type of the base table.
    $table_data = views_fetch_data($this->table);
    $this->entity_type = $table_data['table']['entity type'];
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['field_name'] = array(
      'default' => '',
    );
    $options['formatter'] = array(
      'default' => '',
    );
    $options['settings'] = array(
      'default' => array(),
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {

    // Build a list of available fields.
    $fields = array();
    foreach (field_info_instances($this->settings['entity_type']) as $bundle => $instances) {
      foreach ($instances as $field_name => $field_instance) {
        $fields[$field_name] = $field_name;
      }
    }

    // If no field has been selected yet, or the current one is no longer
    // available, default to the first one.
    if (empty($this->options['field_name']) || !isset($fields[$this->options['field_name']])) {
      $field_names = array_keys($fields);
      $this->options['field_name'] = reset($field_names);
    }
    $form['field_name'] = array(
      '#type' => 'select',
      '#title' => t('Field'),
      '#options' => $fields,
      '#default_value' => $this->options['field_name'],
      '#ajax' => array(
        'path' => views_ui_build_form_url($form_state),
      ),
      '#submit' => array(
        'views_ui_config_item_form_submit_temporary',
      ),
      '#executes_submit_callback' => TRUE,
    );
    $selected_field = field_info_field($this->options['field_name']);
    $formatters = _field_extractor_formatters($selected_field['type']);

    // No recursion.
    unset($formatters['field_extractor']);

    // If no formatter has been selected yet, or doesn't fit the current field,
    // default to the first one.
    if (empty($this->options['formatter']) || !isset($formatters[$this->options['formatter']])) {
      $formatter_names = array_keys($formatters);
      $this->options['formatter'] = reset($formatter_names);
    }
    $form['formatter'] = array(
      '#type' => 'select',
      '#title' => t('Formatter'),
      '#options' => $formatters,
      '#default_value' => $this->options['formatter'],
      '#ajax' => array(
        'path' => views_ui_build_form_url($form_state),
      ),
      '#submit' => array(
        'views_ui_config_item_form_submit_temporary',
      ),
      '#executes_submit_callback' => TRUE,
    );
    $formatter = field_info_formatter_types($this->options['formatter']);
    $formatter_settings = $this->options['settings'] + field_info_formatter_settings($this->options['formatter']);

    // Provide an instance array for hook_field_formatter_settings_form().
    ctools_include('fields');
    $instance = ctools_fields_fake_field_instance($this->options['field_name'], '_dummy', $formatter, $formatter_settings);

    // Store the settings in a '_dummy' view mode.
    $instance['display']['_dummy'] = array(
      'type' => $this->options['formatter'],
      'settings' => $formatter_settings,
    );

    // Get the settings form.
    $settings_form = array(
      '#value' => array(),
    );
    $function = $formatter['module'] . '_field_formatter_settings_form';
    if (function_exists($function)) {
      $settings_form = $function($selected_field, $instance, '_dummy', $element, $form_state);
    }
    $form['settings'] = $settings_form;
    parent::options_form($form, $form_state);
  }

  /**
   * The query method shouldn't do anything, since all information is taken
   * from entities loaded later in the process.
   */
  function query($use_groupby = FALSE) {
  }

  /**
   * Determine if this field is click sortable.
   */
  function click_sortable() {
    return FALSE;
  }

  /**
   * Load the entities for all rows that are about to be displayed.
   */
  function post_execute(&$values) {
    if (!empty($values)) {

      // Load the parent entities.
      list($this->entity_type, $this->entities) = $this->query
        ->get_result_entities($values);

      // Gather a list of referenced ids, load the entities, then store them
      // in $this->referenced_entities grouped by referencing entity id.
      $referenced_ids = array();
      $referenced_ids_by_parent = array();
      foreach ($this->entities as $entity) {
        $items = field_get_items($this->entity_type, $entity, $this->definition['field_name']);
        if (!empty($items)) {
          list($entity_id) = entity_extract_ids($this->entity_type, $entity);
          foreach ($items as $item) {
            $referenced_ids[] = $item[$this->settings['column']];
            $referenced_ids_by_parent[$entity_id][] = $item[$this->settings['column']];
          }
        }
      }
      $referenced_entities = entity_load($this->settings['entity_type'], $referenced_ids);
      foreach ($referenced_ids_by_parent as $entity_id => $referenced_ids) {
        foreach ($referenced_ids as $id) {
          if (!empty($referenced_entities[$id])) {
            $this->referenced_entities[$entity_id][] = $referenced_entities[$id];
          }
        }
      }

      // Build the extracted field data for each row.
      foreach ($values as $row_id => &$value) {
        $entity = $this->entities[$row_id];
        list($entity_id) = entity_extract_ids($this->entity_type, $entity);
        if (!empty($this->referenced_entities[$entity_id])) {
          $element = field_extractor_build_element($this->referenced_entities[$entity_id], $this->settings['entity_type'], $this->options);

          // Only take the items from the renderable array.
          $items = array();
          foreach (element_children($element) as $key) {
            $items[$key] = $element[$key];
          }
        }
        else {
          $items = array();
        }
        $value->{'field_extractor_' . $this->options['id']} = $items;
      }
    }
  }
  function get_items($values) {
    return $values->{'field_extractor_' . $this->options['id']};
  }
  function render_item($count, $item) {
    $item['rendered'] = render($item);
    return $item['rendered'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
field_extractor_handler_field::$entities	public	property	Stores all entites which reference entities used for extracting.
field_extractor_handler_field::$entity_type	public	property	Stores the entity type that contains the reference field.
field_extractor_handler_field::$referenced_entities	public	property	Stores all entites used for extracting.
field_extractor_handler_field::$settings	public	property	Stores the settings relevant to the reference field (entity type it is referencing, allowed bundles, name of the column that stores the ids).
field_extractor_handler_field::click_sortable		function	Determine if this field is click sortable. Overrides views_handler_field::click_sortable
field_extractor_handler_field::get_items		function	Return an array of items for the field. Overrides views_handler_field_prerender_list::get_items
field_extractor_handler_field::init	public	function	Init the handler with necessary data. Overrides views_handler_field::init
field_extractor_handler_field::options_form		function	Default options form provides the label widget that all fields should have. Overrides views_handler_field_prerender_list::options_form
field_extractor_handler_field::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_field_prerender_list::option_definition
field_extractor_handler_field::post_execute		function	Load the entities for all rows that are about to be displayed. Overrides views_handler::post_execute
field_extractor_handler_field::query		function	The query method shouldn't do anything, since all information is taken from entities loaded later in the process. Overrides views_handler_field::query
field_extractor_handler_field::render_item		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::access	public	function	Check whether current user has access to this handler.	10
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::groupby_form	public	function	Provide a form for aggregation settings.	1
views_handler::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.	1
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::add_self_tokens	public	function	Add any special tokens this field might use for itself.	4
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::click_sort	public	function	Called to determine what to tell the clicksorter.	1
views_handler_field::construct	public	function	Construct a new field handler. Overrides views_object::construct	17
views_handler_field::document_self_tokens	public	function	Document any special tokens this field might use for itself.	4
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_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_prerender_list::$items	public	property	Stores all items which are used to render the items.
views_handler_field_prerender_list::allow_advanced_render	public	function	Determine if advanced rendering is allowed. Overrides views_handler_field::allow_advanced_render
views_handler_field_prerender_list::get_value	public	function	Get the value that's supposed to be rendered. Overrides views_handler_field::get_value
views_handler_field_prerender_list::render	public	function	Render the field. Overrides views_handler_field::render
views_handler_field_prerender_list::render_items	public	function	Render all items in this field together.
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

You are here

class field_extractor_handler_field in Field Extractor 7

Hierarchy

File

Members

API Navigation