You are here

class nodequeue_handler_relationship_nodequeue in Nodequeue 6.2

Same name and namespace in other branches
  1. 7.3 includes/views/nodequeue_handler_relationship_nodequeue.inc \nodequeue_handler_relationship_nodequeue
  2. 7.2 includes/views/nodequeue_handler_relationship_nodequeue.inc \nodequeue_handler_relationship_nodequeue

@file Specialized relationship handler to add nodequeues.

Hierarchy

Expanded class hierarchy of nodequeue_handler_relationship_nodequeue

1 string reference to 'nodequeue_handler_relationship_nodequeue'
nodequeue_views_data_alter in includes/views/nodequeue.views.inc
Implementation of hook_views_data_alter().

File

includes/views/nodequeue_handler_relationship_nodequeue.inc, line 7
Specialized relationship handler to add nodequeues.

View source
class nodequeue_handler_relationship_nodequeue extends views_handler_relationship {
  function option_definition() {
    $options = parent::option_definition();
    $options['limit']['default'] = FALSE;
    $options['qids']['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);
    $queues = nodequeue_load_queues(nodequeue_get_all_qids(NULL));
    $form['limit'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit to one or more queues (recommended)'),
      '#default_value' => $this->options['limit'],
    );
    $options = array();
    $queues = nodequeue_load_queues(nodequeue_get_all_qids(NULL));
    foreach ($queues as $queue) {
      $options[$queue->qid] = $queue->title;
    }
    $form['qids'] = array(
      '#prefix' => '<div><div id="edit-options-qids">',
      '#suffix' => '</div></div>',
      '#type' => 'checkboxes',
      '#title' => t('Queues'),
      '#options' => $options,
      '#default_value' => $this->options['qids'],
      '#process' => array(
        'expand_checkboxes',
        'views_process_dependency',
      ),
      '#dependency' => array(
        'edit-options-limit' => array(
          TRUE,
        ),
      ),
    );
  }

  /**
   * Called to implement a relationship in a query.
   */
  function query($group_by = FALSE) {

    // Figure out what base table this relationship brings to the party.
    $join = new views_join();
    $join->definition = array(
      'table' => 'nodequeue_nodes',
      'field' => 'nid',
      'left_table' => 'node',
      'left_field' => 'nid',
    );
    if (!empty($this->options['required'])) {
      $join->definition['type'] = 'INNER';
    }
    if (!empty($this->options['limit'])) {
      $join->definition['extra'] = array(
        array(
          'field' => 'qid',
          'value' => array_filter($this->options['qids']),
          'numeric' => TRUE,
        ),
      );
    }
    $join
      ->construct();
    $alias = $join->definition['table'] . '_' . $join->definition['left_table'];
    $this->alias = $this->query
      ->add_relationship($alias, $join, 'nodequeue_nodes', $this->relationship);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
nodequeue_handler_relationship_nodequeue::options_form function Default options form that provides the label widget that all fields should have.
nodequeue_handler_relationship_nodequeue::option_definition function
nodequeue_handler_relationship_nodequeue::query function Called to implement a relationship in a query.