You are here

Home » API reference » State Machine 7.3 » state_flow_entity_handler_field_state_flow_states_history_list.inc

class state_flow_entity_handler_field_state_flow_states_history_list in State Machine 7.3

@file A field handler to take a record form {state_flow_states} and load all of the relevant history entities.

Hierarchy

Expanded class hierarchy of state_flow_entity_handler_field_state_flow_states_history_list

1 string reference to 'state_flow_entity_handler_field_state_flow_states_history_list'
state_flow_entity_views_data in modules/state_flow_entity/includes/views/state_flow_entity.views.inc
Implements hook_views_data().

File

modules/state_flow_entity/includes/views/state_flow_entity_handler_field_state_flow_states_history_list.inc, line 8
A field handler to take a record form {state_flow_states} and load all of the relevant history entities.

View source 
class state_flow_entity_handler_field_state_flow_states_history_list extends views_handler_field {

  /**
   * Override the construct method to get additional values.
   *
   * Override the construct method to get additional values from the given
   * database row. These will be used to query for related
   * state_flow_history_entities.
   */
  public function construct() {
    parent::construct();
    $this->additional_fields['entity_type'] = array(
      'table' => 'state_flow_states',
      'field' => 'entity_type',
    );
    $this->additional_fields['revision_id'] = array(
      'table' => 'state_flow_states',
      'field' => 'revision_id',
    );
  }

  /**
   * Override pre_render() reduce number of queries.
   *
   * Loads all relevant state_flow_history_entities in one query. They get
   * rendered in chunks in the render() method.
   */
  public function pre_render(&$values) {

    // Call the parent pre_render method on general principle.
    parent::pre_render($values);

    // An array of revision ids. Corresponding state_flow_history_entities will
    // be loaded based on these values.
    // Change to $relevant_revision_ids
    $relevant_revision_ids = array();
    foreach ($values as $result_set) {
      $revision_id = $this
        ->get_value($result_set, 'revision_id');
      $entity_type = $this
        ->get_value($result_set, 'entity_type');
      $relevant_revision_ids[$entity_type][$revision_id] = $revision_id;
    }

    // Use EntityFieldQuery to get the hids of the relevant
    // state_flow_history_entities based on the parent entity_type and
    // revision_ids.
    foreach ($relevant_revision_ids as $parent_entity_type => $keys) {
      $efq = new EntityFieldQuery();
      $efq
        ->entityCondition('entity_type', 'state_flow_history_entity');
      $efq
        ->propertyCondition('entity_type', $parent_entity_type);
      $efq
        ->propertyCondition('revision_id', $keys, 'IN');
      $efq
        ->propertyOrderBy('hid', 'DESC');

      // Execute query and collect results.
      $result = $efq
        ->execute();

      // An array for all the relevant state_flow_history_entity hids.
      $hids = array();
      foreach ($result['state_flow_history_entity'] as $result_object) {
        $hids[$result_object->hid] = $result_object->hid;
      }

      // Load all the relevant history entities.
      $state_flow_history_entities = entity_load('state_flow_history_entity', $hids);

      // Results get rendered in groups by parent revision_id so group the
      // state_flow_history_entities accordingly.
      $state_flow_history_entities_by_revision_id = array();
      foreach ($state_flow_history_entities as $hid => $state_flow_history_entity) {
        $state_flow_history_entities_by_revision_id[$state_flow_history_entity->revision_id][$hid] = $state_flow_history_entity;
      }

      // Store the array on this object so it is available in the render method.
      $this->state_flow_history_entities_by_revision_id[$parent_entity_type] = $state_flow_history_entities_by_revision_id;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function render($values) {

    // @todo, There may be a better place to add this CSS.
    drupal_add_css(drupal_get_path('module', 'state_flow_entity') . '/css/state_flow_entity.css');

    // Get the entity type and revision id for the parent entity.
    $revision_id = $this
      ->get_value($values, 'revision_id');
    $entity_type = $this
      ->get_value($values, 'entity_type');

    // An array of state_flow_history_entities should have been stored on this
    // object in the above pre_render method relevant to this record.
    if (!empty($this->state_flow_history_entities_by_revision_id[$entity_type][$revision_id])) {

      // These are the state_flow_history_entities relevant only to this
      // state_flow_states/parent entity revision_id record.
      $state_flow_history_entities = $this->state_flow_history_entities_by_revision_id[$entity_type][$revision_id];

      // A renderable array.
      $output = array();

      // Add each state_flow_history_entity to the renderable array.
      foreach ($state_flow_history_entities as $hid => $state_flow_history_entity) {
        $output[]['#markup'] = state_flow_entity_state_flow_history_entity_view($state_flow_history_entity, $view_mode = 'full');
      }
      return $output;
    }

    // Return an empty string if there is a fail above.
    return '';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
state_flow_entity_handler_field_state_flow_states_history_list::construct public function Override the construct method to get additional values. Overrides views_handler_field::construct
state_flow_entity_handler_field_state_flow_states_history_list::pre_render public function Override pre_render() reduce number of queries. Overrides views_handler_field::pre_render
state_flow_entity_handler_field_state_flow_states_history_list::render public function Render the field. Overrides views_handler_field::render
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::post_execute public function Run after the view is executed, before the result is cached. 1
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::allow_advanced_render public function Determine if this field can allow advanced rendering. 1
views_handler_field::click_sort public function Called to determine what to tell the clicksorter. 1
views_handler_field::click_sortable public function Determine if this field is click sortable. 1
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::get_value public function Get the value that's supposed to be rendered. 3
views_handler_field::init public function Init the handler with necessary data. Overrides views_handler::init 11
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_form public function Default options form provides the label widget that all fields should have. Overrides views_handler::options_form 33
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::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler::option_definition 33
views_handler_field::query public function Called to add the field to a query. 22
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_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