You are here

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

class state_flow_entity_handler_area_events_form in State Machine 7.3

Views area handlers. Insert a state flow entity form in a view.

Hierarchy

Expanded class hierarchy of state_flow_entity_handler_area_events_form

1 string reference to 'state_flow_entity_handler_area_events_form'
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_area_events_form.inc, line 12
Contains state_flow_entity_handler_area_events_form

View source 
class state_flow_entity_handler_area_events_form extends views_handler_area_text {

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['entity_type'] = array(
      'default' => 'node',
    );
    $options['entity_id'] = array(
      'default' => '',
    );
    $options['entity_to_use'] = array(
      'default' => 'active',
    );
    return $options;
  }

  /**
   * Default options form.
   *
   * Provides the label widget that all fields should have.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    unset($form['content']);
    $form['entity_id'] = array(
      '#title' => 'Entity ID',
      '#description' => 'For what entity id should this form be rendered? For most usages, this will be a node id that is coming in to the View as an argument. If this is the case, use token replacement.',
      '#type' => 'textfield',
      '#default_value' => $this->options['entity_id'],
    );

    // @todo, remove hard-coded node expectation.
    $form['entity_type'] = array(
      '#title' => 'Entity Type',
      '#type' => 'value',
      '#value' => 'node',
      '#default_value' => $this->options['entity_type'],
    );
    $form['entity_to_use'] = array(
      '#type' => 'select',
      '#title' => t('Entity to use'),
      '#options' => array(
        'active' => 'Active',
        'default' => 'Default',
      ),
      '#default_value' => $this->options['entity_to_use'],
      '#description' => t('The active entity is the one that most recently has had a state change or edit. This may or may not be the entity that loads from entity_load(). "Active" is recommended for most usages.'),
    );
  }

  /**
   * Render the area.
   */
  public function render($empty = FALSE) {
    if (!$empty || !empty($this->options['empty'])) {
      if (!empty($this->options['entity_type'])) {
        $entity_type = $this->options['entity_type'];

        // The default text format might return the entity wrapped in p tags and
        // with a line break. Remove those and the result should be a numeric
        // id.
        $entity_id = trim(strip_tags($this
          ->render_textarea($this->options['entity_id'], NULL)));
        if (!empty($entity_id) && is_numeric($entity_id)) {

          // Get the active revision id.
          $default_entity_array = entity_load($entity_type, array(
            $entity_id,
          ));
          if (!empty($default_entity_array) && ($default_entity = array_pop($default_entity_array))) {
            if (!empty($this->options['entity_to_use']) && $this->options['entity_to_use'] == 'active') {
              $entity_info = entity_get_info($entity_type);
              $revision_key = $entity_info['entity keys']['revision'];
              $machine = state_flow_entity_load_state_machine($default_entity, $entity_type);
              $active_revision_id = $machine
                ->get_active_revision();

              // Get the active revision object.
              $conditions = array(
                $revision_key => $active_revision_id,
              );
              $entities = entity_load($entity_type, array(
                $entity_id,
              ), $conditions);
              $entity = array_pop($entities);
            }
            else {
              $entity = $default_entity;
            }
            $form_options = array(
              'assemble_page_title' => FALSE,
              'event_element_type' => 'select',
            );
            module_load_include('inc', 'state_flow_entity', 'state_flow_entity.forms');
            $output = drupal_render(drupal_get_form('state_flow_entity_events_revision', $entity, $entity_type, NULL, $form_options));
            return $output;
          }
        }
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
state_flow_entity_handler_area_events_form::options_form public function Default options form. Overrides views_handler_area_text::options_form
state_flow_entity_handler_area_events_form::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_area_text::option_definition
state_flow_entity_handler_area_events_form::render public function Render the area. Overrides views_handler_area_text::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::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_area::admin_summary public function Provide extra data to the administration form. Overrides views_handler::admin_summary
views_handler_area::init public function Init the handler with necessary data. Overrides views_handler::init
views_handler_area::label public function
views_handler_area::query public function Don't run a query. 1
views_handler_area::use_group_by public function Area handlers shouldn't have groupby. Overrides views_handler::use_group_by
views_handler_area_text::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. Overrides views_handler::options_submit 1
views_handler_area_text::render_textarea public function Render a text area, using the proper format.
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::construct public function Views handlers use a special construct function. 4
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