class entityqueue_handler_relationship_entityqueue in Entityqueue 7

@file Specialized relationship handler to add entityqueues.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_relationship
    class \views_handler_relationship_entity_reverse
    class \entityqueue_handler_relationship_entityqueue

Expanded class hierarchy of entityqueue_handler_relationship_entityqueue

1 string reference to 'entityqueue_handler_relationship_entityqueue'

entityqueue_views_data_alter in includes/views/entityqueue.views.inc: Implements hook_views_data_alter().

File

includes/views/entityqueue_handler_relationship_entityqueue.inc, line 8: Specialized relationship handler to add entityqueues.

View source

class entityqueue_handler_relationship_entityqueue extends views_handler_relationship_entity_reverse {
  function option_definition() {
    $options = parent::option_definition();
    $options['limit']['default'] = FALSE;
    $options['queues']['default'] = array();
    return $options;
  }

  /**
   * Default options form that provides the label widget that all fields
   * should have.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['limit'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit to one or more queues (recommended)'),
      '#default_value' => $this->options['limit'],
    );
    $views_data = views_fetch_data($this->table);
    $subqueues = entityqueue_subqueue_load_by_target_type($views_data['table']['entity type']);
    $form['queues'] = array(
      '#prefix' => '<div><div id="edit-options-queues">',
      '#suffix' => '</div></div>',
      '#type' => 'checkboxes',
      '#title' => t('Queues'),
      '#options' => entityqueue_get_options($subqueues),
      '#default_value' => $this->options['queues'],
      '#process' => array(
        'form_process_checkboxes',
        'ctools_dependent_process',
      ),
      '#dependency' => array(
        'edit-options-limit' => array(
          TRUE,
        ),
      ),
    );
  }

  /**
   * Overrides views_handler_relationship_entity_reverse::query().
   *
   * Adds an extra condition to the second join from the parent query.
   */
  function query() {
    $this
      ->ensure_my_table();

    // First, relate our base table to the current base table to the
    // field, using the base table's id field to the field's column.
    $views_data = views_fetch_data($this->table);
    $left_field = $views_data['table']['base']['field'];
    $first = array(
      'left_table' => $this->table_alias,
      'left_field' => $left_field,
      'table' => $this->definition['field table'],
      'field' => $this->definition['field field'],
    );
    if (!empty($this->options['required'])) {
      $first['type'] = 'INNER';
    }

    // Add an extra condition to limit results based on the queue selection.
    if (!empty($this->options['limit'])) {
      $queues = array_keys(array_filter($this->options['queues']));
      if (!empty($queues)) {
        $queue_names = db_select('entityqueue_subqueue', 'esq')
          ->fields('esq', array(
          'queue',
        ))
          ->distinct()
          ->condition('esq.name', $queues, 'IN')
          ->execute()
          ->fetchCol();
        $first['extra'] = array(
          array(
            'field' => 'bundle',
            'value' => $queue_names,
          ),
        );
      }
    }
    if (!empty($this->definition['join_extra'])) {
      if (!isset($first['extra'])) {
        $first['extra'] = array();
      }
      $first['extra'] += $this->definition['join_extra'];
    }
    if (!empty($this->definition['join_handler']) && class_exists($this->definition['join_handler'])) {
      $first_join = new $this->definition['join_handler']();
    }
    else {
      $first_join = new views_join();
    }
    $first_join->definition = $first;
    $first_join
      ->construct();
    $first_join->adjusted = TRUE;
    $this->first_alias = $this->query
      ->add_table($this->definition['field table'], $this->relationship, $first_join);

    // Second, relate the field table to the entity specified using
    // the entity id on the field table and the entity's id field.
    $second = array(
      'left_table' => $this->first_alias,
      'left_field' => 'entity_id',
      'table' => $this->definition['base'],
      'field' => $this->definition['base field'],
    );
    if (!empty($this->options['required'])) {
      $second['type'] = 'INNER';
    }

    // Add an extra condition to limit results based on the queue selection.
    if (!empty($this->options['limit'])) {
      $queues = array_keys(array_filter($this->options['queues']));
      if (!empty($queues)) {
        $second['extra'] = array(
          array(
            'field' => 'name',
            'value' => $queues,
          ),
        );
      }
    }
    if (!empty($this->definition['join_handler']) && class_exists($this->definition['join_handler'])) {
      $second_join = new $this->definition['join_handler']();
    }
    else {
      $second_join = new views_join();
    }
    $second_join->definition = $second;
    $second_join
      ->construct();
    $second_join->adjusted = TRUE;

    // use a short alias for this:
    $alias = $this->definition['field_name'] . '_' . $this->table;
    $this->alias = $this->query
      ->add_relationship($alias, $second_join, $this->definition['base'], $this->relationship);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
entityqueue_handler_relationship_entityqueue::options_form		function	Default options form that provides the label widget that all fields should have. Overrides views_handler_relationship::options_form
entityqueue_handler_relationship_entityqueue::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_relationship::option_definition
entityqueue_handler_relationship_entityqueue::query		function	Overrides views_handler_relationship_entity_reverse::query(). Overrides views_handler_relationship_entity_reverse::query
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::admin_summary	public	function	Provide text for the administrative summary.	4
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_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.	5
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_relationship::label	public	function	Get this field's label.
views_handler_relationship::use_group_by	public	function	You can't groupby a relationship. Overrides views_handler::use_group_by
views_handler_relationship_entity_reverse::init	public	function	Let relationships live on tables other than the table they operate on. Overrides views_handler_relationship::init
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

You are here

class entityqueue_handler_relationship_entityqueue in Entityqueue 7

Hierarchy

File

Members

API Navigation