class quiz_views_handler_argument_quiz_nid in Quiz 7

Hierarchy

• class \views_object
  • class \views_handler
    • class \views_handler_argument
      • class \views_handler_argument_numeric
        • class \quiz_views_handler_argument_quiz_nid

1 string reference to 'quiz_views_handler_argument_quiz_nid'

quiz_views_data in includes/views/quiz.views.inc

Implementation of hook_views_data().

File

includes/views/handlers/quiz_views_handler_argument_quiz_nid.inc, line 8

class quiz_views_handler_argument_quiz_nid extends views_handler_argument_numeric {

  /**
   * An array that the subselect will fill with all the corresponding quiz node,
   * according to the configuration on the argument settings form. These vids
   * will then be the actual ones used while generating the real query.
   *
   * @var array
   */
  var $corresponding_vids = array();
  var $phrase_broken = FALSE;
  function construct() {
    parent::construct();
    $this->nid_field = $this->definition['nid field'];
    $this->vid_field = isset($this->definition['vid field']) ? $this->definition['vid field'] : 'vid';
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['which_vid'] = array(
      'default' => 'latest',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // Set weighting so that our element can sanely ordered
    $form['title']['#weight'] = -2;

    //    $form['default_action']['#weight'] = -3;
    //    $form['wildcard']['#weight'] = -4;
    //    $form['wildcard_substitution']['#weight'] = -4;
    $form['which_vid'] = array(
      '#type' => 'select',
      '#title' => t('Quiz revision(s) to use'),
      '#options' => array(
        'latest' => t('Latest: most recent version of the quiz ONLY.'),
        'initial' => t('Initial: original version of the quiz ONLY.'),
        'all' => t('All: ALL versions of the quiz.'),
      ),
      '#description' => t('The validator will transform the incoming quiz node id(s) into one or more quiz node revisions, depending on your selection.'),
      '#default_value' => $this->options['which_vid'],
      '#weight' => -1,
    );
  }
  function title_query() {
    $titles = array();
    $placeholders = implode(', ', array_fill(0, count($this->corresponding_vids), '%d'));

    // TODO Please convert this statement to the D7 database API syntax.
    $result = db_query("SELECT n.title FROM {node_revision} n WHERE n.vid IN ({$placeholders})", $this->corresponding_vids);
    while ($term = $result
      ->fetch()) {
      $titles[] = check_plain($term->title);
    }
    return $titles;
  }

  /**
   * Override the default behavior of query() to introduce the medial step of
   * retrieving vids from the provided nids.
   */
  function query() {
    $this
      ->ensure_my_table();
    $this
      ->break_phrase();

    // Do subselect to get relevant vids, then add where clause
    if ($this
      ->subselect_vids()) {
      $placeholders = implode(', ', array_fill(0, count($this->corresponding_vids), '%d'));
      $this->query
        ->add_where(0, "{$this->table_alias}.{$this->nid_field} IN ({$placeholders})", $this->corresponding_vids);
    }
    else {
      $this->query
        ->add_where(0, "{$this->table_alias}.{$this->nid_field}", $this->corresponding_vids);
    }
  }

  /**
   * Set up the argument with the vids extracted from nids.
   *
   * Needs to be done here, because this is the earliest stage at which we can
   * guarantee the contents of $this->argument to be available.
   *
   * @param string $arg
   *   The argument, as delivered in the URL.
   */
  function set_argument($arg) {
    $this->argument = $arg;
    if ($this
      ->validate_arg($arg)) {
      $this
        ->break_phrase();
      $this
        ->subselect_vids();
      return TRUE;
    }
    return FALSE;
  }
  function break_phrase() {
    if (!$this->phrase_broken) {

      // Handle multiple argument inputs
      if (!empty($this->options['break_phrase'])) {
        views_break_phrase($this->argument, $this);
      }
      else {
        $this->value = array(
          $this->argument,
        );
      }
      $this->phrase_broken = TRUE;
    }
  }

  /**
   * Helper method to retrieve the vid(s) the final view query should actually
   * be run against.
   *
   * Would be done in pre_query(), but $this->argument is not yet available at
   * that time. So, called from set_argument().
   */
  function subselect_vids() {
    $from = 'FROM {quiz_node_properties} qnp';
    $field = 'qnp.vid';
    if (count($this->value) > 1) {

      // Guaranteed to produce multiple values; therefore may need the group by
      $use_group_by = TRUE;
      $operator = empty($this->options['not']) ? 'IN' : 'NOT IN';
      $placeholders = implode(', ', array_fill(0, count($this->value), '%d'));
      $where = "WHERE qnp.nid {$operator} ({$placeholders})";
    }
    else {

      // Multiple values only possible with a NOT; only then do we need group by
      $use_group_by = !empty($this->options['not']);
      $operator = empty($this->options['not']) ? '=' : '!=';
      $where = "WHERE qnp.nid {$operator} :nid";
    }
    switch ($this->options['which_vid']) {
      case 'initial':
      case 'latest':

        // SQL operation for getting a single vids based on view config settings
        $operation = $this->options['which_vid'] == 'initial' ? 'MIN' : 'MAX';

        // If we need a group by clause, tag it onto the end.
        $where .= $use_group_by ? ' GROUP BY qnp.nid' : '';

        // TODO Please convert this statement to the D7 database API syntax.
        $result = db_query("SELECT {$operation}(qnp.vid) AS vid {$from} {$where}", array(
          ':nid' => $this->value,
        ));
        break;
      case 'all':

        // TODO Please convert this statement to the D7 database API syntax.
        $result = db_query("SELECT qnp.vid AS vid {$from} {$where}", $this->value);
        break;
    }
    $this->nid_field = $this->vid_field;
    $this->corresponding_vids = array();
    while ($item = $result
      ->fetch()) {
      $this->corresponding_vids[] = $item->vid;
    }
    return count($this->corresponding_vids) > 1;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
quiz_views_handler_argument_quiz_nid::$corresponding_vids		property	An array that the subselect will fill with all the corresponding quiz node, according to the configuration on the argument settings form. These vids will then be the actual ones used while generating the real query.
quiz_views_handler_argument_quiz_nid::$phrase_broken		property
quiz_views_handler_argument_quiz_nid::break_phrase		function
quiz_views_handler_argument_quiz_nid::construct		function	Views handlers use a special construct function. Overrides views_handler_argument::construct
quiz_views_handler_argument_quiz_nid::options_form		function	Build the options form. Overrides views_handler_argument_numeric::options_form
quiz_views_handler_argument_quiz_nid::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_argument_numeric::option_definition
quiz_views_handler_argument_quiz_nid::query		function	Override the default behavior of query() to introduce the medial step of retrieving vids from the provided nids. Overrides views_handler_argument_numeric::query
quiz_views_handler_argument_quiz_nid::set_argument		function	Set up the argument with the vids extracted from nids. Overrides views_handler_argument::set_argument
quiz_views_handler_argument_quiz_nid::subselect_vids		function	Helper method to retrieve the vid(s) the final view query should actually be run against.
quiz_views_handler_argument_quiz_nid::title_query		function	Override for specific title lookups. Overrides views_handler_argument_numeric::title_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::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::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_argument::$argument	public	property
views_handler_argument::$name_field	public	property	The field to use for the name to use in the summary.
views_handler_argument::$name_table	public	property	The table to use for the name, if not the same table as the argument.
views_handler_argument::$validator	public	property
views_handler_argument::default_access_denied	public	function	Default action: access denied.
views_handler_argument::default_action	public	function	Handle the default action, which means our argument wasn't present.
views_handler_argument::default_actions	public	function	List of default behaviors for this argument if the argument is not present.	4
views_handler_argument::default_argument_form	public	function	Provide a form for selecting the default argument.	1
views_handler_argument::default_default	public	function	This just returns true.
views_handler_argument::default_empty	public	function	Default action: empty.
views_handler_argument::default_ignore	public	function	Default action: ignore.
views_handler_argument::default_not_found	public	function	Default action: not found.
views_handler_argument::default_summary	public	function	Default action: summary.
views_handler_argument::default_summary_form	public	function	Form for selecting further summary options.
views_handler_argument::exception_title	public	function	Work out which title to use.
views_handler_argument::export_plugin	public	function	Generic plugin export handler.	1
views_handler_argument::export_summary	public	function	Export handler for summary export.
views_handler_argument::export_validation	public	function	Export handler for validation export.
views_handler_argument::get_default_argument	public	function	Get a default argument, if available.	1
views_handler_argument::get_plugin	public	function	Get the display or row plugin, if it exists.
views_handler_argument::get_title	public	function	Called by the view object to get the title.
views_handler_argument::get_value	public	function	Get the value of this argument.
views_handler_argument::has_default_argument	public	function	Determine if the argument is set to provide a default argument.
views_handler_argument::init	public	function	Init the handler with necessary data. Overrides views_handler::init	3
views_handler_argument::is_exception	public	function
views_handler_argument::needs_style_plugin	public	function	Determine if the argument needs a style plugin. Overrides views_handler::needs_style_plugin
views_handler_argument::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
views_handler_argument::options_validate	public	function	Validate the options form. Overrides views_handler::options_validate
views_handler_argument::process_summary_arguments	public	function	Process the summary arguments for display.
views_handler_argument::set_breadcrumb	public	function	Give an argument the opportunity to modify the breadcrumb, if it wants.	3
views_handler_argument::summary_argument	public	function	Provide the argument to use to link from the summary to the next level.	4
views_handler_argument::summary_basics	public	function	Some basic summary behavior.
views_handler_argument::summary_name	public	function	Provides the name to use for the summary.	10
views_handler_argument::summary_name_field	public	function	Add the name field, which is the field displayed in summary queries.
views_handler_argument::summary_query	public	function	Build the info for the summary query.	3
views_handler_argument::summary_sort	public	function	Sorts the summary based upon the user's selection.
views_handler_argument::uses_breadcrumb	public	function	Determine if the argument can generate a breadcrumb.
views_handler_argument::validate_arg	public	function	Validate that this argument works. By default, all arguments are valid.
views_handler_argument::validate_argument	public	function	Called by the menu system to validate an argument.
views_handler_argument::validate_argument_basic	public	function	Provide a basic argument validation.	1
views_handler_argument::validate_fail	public	function	How to act if validation fails.
views_handler_argument_numeric::$operator	public	property	The operator used for the query: or|and.
views_handler_argument_numeric::$value	public	property	The actual value which is used for querying. Overrides views_handler_argument::$value
views_handler_argument_numeric::get_sort_name	public	function	Return a description of how the argument would normally be sorted. Overrides views_handler_argument::get_sort_name
views_handler_argument_numeric::title	public	function	Get the title this argument will assign the view, given the argument. Overrides views_handler_argument::title	2
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