danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * @todo.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @defgroup views_argument_handlers Views argument handlers
danielebarchiesi@0:  * Handlers to tell Views how to contextually filter queries.
danielebarchiesi@0:  * @{
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Base class for arguments.
danielebarchiesi@0:  *
danielebarchiesi@0:  * The basic argument works for very simple arguments such as nid and uid
danielebarchiesi@0:  *
danielebarchiesi@0:  * Definition terms for this handler:
danielebarchiesi@0:  * - name field: The field to use for the name to use in the summary, which is
danielebarchiesi@0:  *               the displayed output. For example, for the node: nid argument,
danielebarchiesi@0:  *               the argument itself is the nid, but node.title is displayed.
danielebarchiesi@0:  * - name table: The table to use for the name, should it not be in the same
danielebarchiesi@0:  *               table as the argument.
danielebarchiesi@0:  * - empty field name: For arguments that can have no value, such as taxonomy
danielebarchiesi@0:  *                     which can have "no term", this is the string which
danielebarchiesi@0:  *                     will be displayed for this lack of value. Be sure to use
danielebarchiesi@0:  *                     t().
danielebarchiesi@0:  * - validate type: A little used string to allow an argument to restrict
danielebarchiesi@0:  *                  which validator is available to just one. Use the
danielebarchiesi@0:  *                  validator ID. This probably should not be used at all,
danielebarchiesi@0:  *                  and may disappear or change.
danielebarchiesi@0:  * - numeric: If set to TRUE this field is numeric and will use %d instead of
danielebarchiesi@0:  *            %s in queries.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @ingroup views_argument_handlers
danielebarchiesi@0:  */
danielebarchiesi@0: class views_handler_argument extends views_handler {
danielebarchiesi@0:   var $validator = NULL;
danielebarchiesi@0:   var $argument = NULL;
danielebarchiesi@0:   var $value = NULL;
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * The table to use for the name, should it not be in the same table as the argument.
danielebarchiesi@0:    * @var string
danielebarchiesi@0:    */
danielebarchiesi@0:   var $name_table;
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * The field to use for the name to use in the summary, which is
danielebarchiesi@0:    * the displayed output. For example, for the node: nid argument,
danielebarchiesi@0:    * the argument itself is the nid, but node.title is displayed.
danielebarchiesi@0:    * @var string
danielebarchiesi@0:    */
danielebarchiesi@0:   var $name_field;
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Constructor
danielebarchiesi@0:    */
danielebarchiesi@0:   function construct() {
danielebarchiesi@0:     parent::construct();
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($this->definition['name field'])) {
danielebarchiesi@0:       $this->name_field = $this->definition['name field'];
danielebarchiesi@0:     }
danielebarchiesi@0:     if (!empty($this->definition['name table'])) {
danielebarchiesi@0:       $this->name_table = $this->definition['name table'];
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function init(&$view, &$options) {
danielebarchiesi@0:     parent::init($view, $options);
danielebarchiesi@0: 
danielebarchiesi@0:     // Compatibility: The new UI changed several settings.
danielebarchiesi@0:     if (!empty($options['wildcard']) && !isset($options['exception']['value'])) {
danielebarchiesi@0:       $this->options['exception']['value'] = $options['wildcard'];
danielebarchiesi@0:     }
danielebarchiesi@0:     if (!empty($options['wildcard_substitution']) && !isset($options['exception']['title'])) {
danielebarchiesi@0:       // Enable the checkbox if the title is filled in.
danielebarchiesi@0:       $this->options['exception']['title_enable'] = 1;
danielebarchiesi@0:       $this->options['exception']['title'] = $options['wildcard_substitution'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!isset($options['summary']['format']) && !empty($options['style_plugin'])) {
danielebarchiesi@0:       $this->options['summary']['format'] = $options['style_plugin'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Setup default value.
danielebarchiesi@0:     $options['style_options'] = isset($options['style_options']) ? $options['style_options'] : array();
danielebarchiesi@0: 
danielebarchiesi@0:     if (!isset($options['summary']['sort_order']) && !empty($options['default_action']) && $options['default_action'] == 'summary asc') {
danielebarchiesi@0:       $this->options['default_action'] = 'summary';
danielebarchiesi@0:       $this->options['summary']['sort_order'] = 'asc';
danielebarchiesi@0:       $this->options['summary']['number_of_records'] = 0;
danielebarchiesi@0:       $this->options['summary_options'] = $options['style_options'];
danielebarchiesi@0:     }
danielebarchiesi@0:     elseif (!isset($options['summary']['sort_order']) && !empty($options['default_action']) && $options['default_action'] == 'summary desc') {
danielebarchiesi@0:       $this->options['default_action'] = 'summary';
danielebarchiesi@0:       $this->options['summary']['sort_order'] = 'desc';
danielebarchiesi@0:       $this->options['summary']['number_of_records'] = 0;
danielebarchiesi@0:       $this->options['summary_options'] = $options['style_options'];
danielebarchiesi@0:     }
danielebarchiesi@0:     elseif (!isset($options['summary']['sort_order']) && !empty($options['default_action']) && $options['default_action'] == 'summary asc by count') {
danielebarchiesi@0:       $this->options['default_action'] = 'summary';
danielebarchiesi@0:       $this->options['summary']['sort_order'] = 'asc';
danielebarchiesi@0:       $this->options['summary']['number_of_records'] = 1;
danielebarchiesi@0:       $this->options['summary_options'] = $options['style_options'];
danielebarchiesi@0:     }
danielebarchiesi@0:     elseif (!isset($options['summary']['sort_order']) && !empty($options['default_action']) && $options['default_action'] == 'summary desc by count') {
danielebarchiesi@0:       $this->options['default_action'] = 'summary';
danielebarchiesi@0:       $this->options['summary']['sort_order'] = 'desc';
danielebarchiesi@0:       $this->options['summary']['number_of_records'] = 1;
danielebarchiesi@0:       $this->options['summary_options'] = $options['style_options'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($options['title']) && !isset($options['title_enable'])) {
danielebarchiesi@0:       $this->options['title_enable'] = 1;
danielebarchiesi@0:     }
danielebarchiesi@0:     if (!empty($options['breadcrumb']) && !isset($options['breadcrumb_enable'])) {
danielebarchiesi@0:       $this->options['breadcrumb_enable'] = 1;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($options['validate_type']) && !isset($options['validate']['type'])) {
danielebarchiesi@0:       $this->options['validate']['type'] = $options['validate_type'];
danielebarchiesi@0:       $this->options['specify_validation'] = 1;
danielebarchiesi@0:     }
danielebarchiesi@0:     if (!empty($options['validate_fail']) && !isset($options['validate']['fail'])) {
danielebarchiesi@0:       $this->options['validate']['fail'] = $options['validate_fail'];
danielebarchiesi@0:       $this->options['specify_validation'] = 1;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Give an argument the opportunity to modify the breadcrumb, if it wants.
danielebarchiesi@0:    * This only gets called on displays where a breadcrumb is actually used.
danielebarchiesi@0:    *
danielebarchiesi@0:    * The breadcrumb will be in the form of an array, with the keys being
danielebarchiesi@0:    * the path and the value being the already sanitized title of the path.
danielebarchiesi@0:    */
danielebarchiesi@0:   function set_breadcrumb(&$breadcrumb) { }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Determine if the argument can generate a breadcrumb
danielebarchiesi@0:    *
danielebarchiesi@0:    * @return TRUE/FALSE
danielebarchiesi@0:    */
danielebarchiesi@0:   function uses_breadcrumb() {
danielebarchiesi@0:     $info = $this->default_actions($this->options['default_action']);
danielebarchiesi@0:     return !empty($info['breadcrumb']);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function is_exception($arg = NULL) {
danielebarchiesi@0:     if (!isset($arg)) {
danielebarchiesi@0:       $arg = isset($this->argument) ? $this->argument : NULL;
danielebarchiesi@0:     }
danielebarchiesi@0:     return !empty($this->options['exception']['value']) && $this->options['exception']['value'] === $arg;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function exception_title() {
danielebarchiesi@0:     // If title overriding is off for the exception, return the normal title.
danielebarchiesi@0:     if (empty($this->options['exception']['title_enable'])) {
danielebarchiesi@0:       return $this->get_title();
danielebarchiesi@0:     }
danielebarchiesi@0:     return $this->options['exception']['title'];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Determine if the argument needs a style plugin.
danielebarchiesi@0:    *
danielebarchiesi@0:    * @return TRUE/FALSE
danielebarchiesi@0:    */
danielebarchiesi@0:   function needs_style_plugin() {
danielebarchiesi@0:     $info = $this->default_actions($this->options['default_action']);
danielebarchiesi@0:     $validate_info = $this->default_actions($this->options['validate']['fail']);
danielebarchiesi@0:     return !empty($info['style plugin']) || !empty($validate_info['style plugin']);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function option_definition() {
danielebarchiesi@0:     $options = parent::option_definition();
danielebarchiesi@0: 
danielebarchiesi@0:     $options['default_action'] = array('default' => 'ignore');
danielebarchiesi@0:     $options['exception'] = array(
danielebarchiesi@0:       'contains' => array(
danielebarchiesi@0:         'value' => array('default' => 'all'),
danielebarchiesi@0:         'title_enable' => array('default' => FALSE, 'bool' => TRUE),
danielebarchiesi@0:         'title' => array('default' => 'All', 'translatable' => TRUE),
danielebarchiesi@0:       ),
danielebarchiesi@0:     );
danielebarchiesi@0:     $options['title_enable'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0:     $options['title'] = array('default' => '', 'translatable' => TRUE);
danielebarchiesi@0:     $options['breadcrumb_enable'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0:     $options['breadcrumb'] = array('default' => '', 'translatable' => TRUE);
danielebarchiesi@0:     $options['default_argument_type'] = array('default' => 'fixed', 'export' => 'export_plugin');
danielebarchiesi@0:     $options['default_argument_options'] = array('default' => array(), 'export' => FALSE);
danielebarchiesi@0:     $options['default_argument_skip_url'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0:     $options['summary_options'] = array('default' => array(), 'export' => FALSE);
danielebarchiesi@0:     $options['summary'] = array(
danielebarchiesi@0:       'contains' => array(
danielebarchiesi@0:         'sort_order' => array('default' => 'asc'),
danielebarchiesi@0:         'number_of_records' => array('default' => 0),
danielebarchiesi@0:         'format' => array('default' => 'default_summary', 'export' => 'export_summary'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     );
danielebarchiesi@0:     $options['specify_validation'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0:     $options['validate'] = array(
danielebarchiesi@0:       'contains' => array(
danielebarchiesi@0:         'type' => array('default' => 'none', 'export' => 'export_validation'),
danielebarchiesi@0:         'fail' => array('default' => 'not found'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     );
danielebarchiesi@0:     $options['validate_options'] = array('default' => array(), 'export' => FALSE);
danielebarchiesi@0: 
danielebarchiesi@0:     return $options;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function options_form(&$form, &$form_state) {
danielebarchiesi@0:     parent::options_form($form, $form_state);
danielebarchiesi@0: 
danielebarchiesi@0:     $argument_text = $this->view->display_handler->get_argument_text();
danielebarchiesi@0: 
danielebarchiesi@0:     $form['#pre_render'][] = 'views_ui_pre_render_move_argument_options';
danielebarchiesi@0: 
danielebarchiesi@0:     $form['description'] = array(
danielebarchiesi@0:       '#markup' => $argument_text['description'],
danielebarchiesi@0:       '#theme_wrappers' => array('container'),
danielebarchiesi@0:       '#attributes' => array('class' => array('description')),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['no_argument'] = array(
danielebarchiesi@0:       '#type' => 'fieldset',
danielebarchiesi@0:       '#title' => $argument_text['filter value not present'],
danielebarchiesi@0:     );
danielebarchiesi@0:     // Everything in the fieldset is floated, so the last element needs to
danielebarchiesi@0:     // clear those floats.
danielebarchiesi@0:     $form['no_argument']['clearfix'] = array(
danielebarchiesi@0:       '#weight' => 1000,
danielebarchiesi@0:       '#markup' => '<div class="clearfix"></div>',
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['default_action'] = array(
danielebarchiesi@0:       '#type' => 'radios',
danielebarchiesi@0:       '#process' => array('views_ui_process_container_radios'),
danielebarchiesi@0:       '#default_value' => $this->options['default_action'],
danielebarchiesi@0:       '#fieldset' => 'no_argument',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['exception'] = array(
danielebarchiesi@0:       '#type' => 'fieldset',
danielebarchiesi@0:       '#title' => t('Exceptions'),
danielebarchiesi@0:       '#collapsible' => TRUE,
danielebarchiesi@0:       '#collapsed' => TRUE,
danielebarchiesi@0:       '#fieldset' => 'no_argument',
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['exception']['value'] = array(
danielebarchiesi@0:       '#type' => 'textfield',
danielebarchiesi@0:       '#title' => t('Exception value'),
danielebarchiesi@0:       '#size' => 20,
danielebarchiesi@0:       '#default_value' => $this->options['exception']['value'],
danielebarchiesi@0:       '#description' => t('If this value is received, the filter will be ignored; i.e, "all values"'),
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['exception']['title_enable'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Override title'),
danielebarchiesi@0:       '#default_value' => $this->options['exception']['title_enable'],
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['exception']['title'] = array(
danielebarchiesi@0:       '#type' => 'textfield',
danielebarchiesi@0:       '#title' => t('Override title'),
danielebarchiesi@0:       '#title_display' => 'invisible',
danielebarchiesi@0:       '#size' => 20,
danielebarchiesi@0:       '#default_value' => $this->options['exception']['title'],
danielebarchiesi@0:       '#description' => t('Override the view and other argument titles. Use "%1" for the first argument, "%2" for the second, etc.'),
danielebarchiesi@0:       '#dependency' => array(
danielebarchiesi@0:         'edit-options-exception-title-enable' => array('1'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $options = array();
danielebarchiesi@0:     $defaults = $this->default_actions();
danielebarchiesi@0:     $validate_options = array();
danielebarchiesi@0:     foreach ($defaults as $id => $info) {
danielebarchiesi@0:       $options[$id] = $info['title'];
danielebarchiesi@0:       if (empty($info['default only'])) {
danielebarchiesi@0:         $validate_options[$id] = $info['title'];
danielebarchiesi@0:       }
danielebarchiesi@0:       if (!empty($info['form method'])) {
danielebarchiesi@0:         $this->{$info['form method']}($form, $form_state);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     $form['default_action']['#options'] = $options;
danielebarchiesi@0: 
danielebarchiesi@0:     $form['argument_present'] = array(
danielebarchiesi@0:       '#type' => 'fieldset',
danielebarchiesi@0:       '#title' => $argument_text['filter value present'],
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['title_enable'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Override title'),
danielebarchiesi@0:       '#default_value' => $this->options['title_enable'],
danielebarchiesi@0:       '#fieldset' => 'argument_present',
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['title'] = array(
danielebarchiesi@0:       '#type' => 'textfield',
danielebarchiesi@0:       '#title' => t('Provide title'),
danielebarchiesi@0:       '#title_display' => 'invisible',
danielebarchiesi@0:       '#default_value' => $this->options['title'],
danielebarchiesi@0:       '#description' => t('Override the view and other argument titles. Use "%1" for the first argument, "%2" for the second, etc.'),
danielebarchiesi@0:       '#dependency' => array(
danielebarchiesi@0:         'edit-options-title-enable' => array('1'),
danielebarchiesi@0:       ),
danielebarchiesi@0:       '#fieldset' => 'argument_present',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['breadcrumb_enable'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Override breadcrumb'),
danielebarchiesi@0:       '#default_value' => $this->options['breadcrumb_enable'],
danielebarchiesi@0:       '#fieldset' => 'argument_present',
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['breadcrumb'] = array(
danielebarchiesi@0:       '#type' => 'textfield',
danielebarchiesi@0:       '#title' => t('Provide breadcrumb'),
danielebarchiesi@0:       '#title_display' => 'invisible',
danielebarchiesi@0:       '#default_value' => $this->options['breadcrumb'],
danielebarchiesi@0:       '#description' => t('Enter a breadcrumb name you would like to use. See "Title" for percent substitutions.'),
danielebarchiesi@0:       '#dependency' => array(
danielebarchiesi@0:         'edit-options-breadcrumb-enable' => array('1'),
danielebarchiesi@0:       ),
danielebarchiesi@0:       '#fieldset' => 'argument_present',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['specify_validation'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Specify validation criteria'),
danielebarchiesi@0:       '#default_value' => $this->options['specify_validation'],
danielebarchiesi@0:       '#fieldset' => 'argument_present',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['validate'] = array(
danielebarchiesi@0:       '#type' => 'container',
danielebarchiesi@0:       '#fieldset' => 'argument_present',
danielebarchiesi@0:     );
danielebarchiesi@0:     // @todo The mockup wanted to use "Validate using" here, but it doesn't
danielebarchiesi@0:     // work well with many options (they'd need to be changed as well)
danielebarchiesi@0:     $form['validate']['type'] = array(
danielebarchiesi@0:       '#type' => 'select',
danielebarchiesi@0:       '#title' => t('Validator'),
danielebarchiesi@0:       '#default_value' => $this->options['validate']['type'],
danielebarchiesi@0:       '#dependency' => array(
danielebarchiesi@0:         'edit-options-specify-validation' => array('1'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $validate_types = array('none' => t('- Basic validation -'));
danielebarchiesi@0:     $plugins = views_fetch_plugin_data('argument validator');
danielebarchiesi@0:     foreach ($plugins as $id => $info) {
danielebarchiesi@0:       if (!empty($info['no ui'])) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       $valid = TRUE;
danielebarchiesi@0:       if (!empty($info['type'])) {
danielebarchiesi@0:         $valid = FALSE;
danielebarchiesi@0:         if (empty($this->definition['validate type'])) {
danielebarchiesi@0:           continue;
danielebarchiesi@0:         }
danielebarchiesi@0:         foreach ((array) $info['type'] as $type) {
danielebarchiesi@0:           if ($type == $this->definition['validate type']) {
danielebarchiesi@0:             $valid = TRUE;
danielebarchiesi@0:             break;
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       // If we decide this validator is ok, add it to the list.
danielebarchiesi@0:       if ($valid) {
danielebarchiesi@0:         $plugin = $this->get_plugin('argument validator', $id);
danielebarchiesi@0:         if ($plugin) {
danielebarchiesi@0:           if ($plugin->access() || $this->options['validate']['type'] == $id) {
danielebarchiesi@0:             $form['validate']['options'][$id] = array(
danielebarchiesi@0:               '#prefix' => '<div id="edit-options-validate-options-' . $id . '-wrapper">',
danielebarchiesi@0:               '#suffix' => '</div>',
danielebarchiesi@0:               '#type' => 'item',
danielebarchiesi@0:               // Even if the plugin has no options add the key to the form_state.
danielebarchiesi@0:               '#input' => TRUE, // trick it into checking input to make #process run
danielebarchiesi@0:               '#dependency' => array(
danielebarchiesi@0:                 'edit-options-specify-validation' => array('1'),
danielebarchiesi@0:                 'edit-options-validate-type' => array($id),
danielebarchiesi@0:               ),
danielebarchiesi@0:               '#dependency_count' => 2,
danielebarchiesi@0:               '#id' => 'edit-options-validate-options-' . $id,
danielebarchiesi@0:             );
danielebarchiesi@0:             $plugin->options_form($form['validate']['options'][$id], $form_state);
danielebarchiesi@0:             $validate_types[$id] = $info['title'];
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     asort($validate_types);
danielebarchiesi@0:     $form['validate']['type']['#options'] = $validate_types;
danielebarchiesi@0: 
danielebarchiesi@0:     $form['validate']['fail'] = array(
danielebarchiesi@0:       '#type' => 'select',
danielebarchiesi@0:       '#title' => t('Action to take if filter value does not validate'),
danielebarchiesi@0:       '#default_value' => $this->options['validate']['fail'],
danielebarchiesi@0:       '#options' => $validate_options,
danielebarchiesi@0:       '#dependency' => array(
danielebarchiesi@0:         'edit-options-specify-validation' => array('1'),
danielebarchiesi@0:       ),
danielebarchiesi@0:       '#fieldset' => 'argument_present',
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function options_validate(&$form, &$form_state) {
danielebarchiesi@0:     if (empty($form_state['values']['options'])) {
danielebarchiesi@0:       return;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Let the plugins do validation.
danielebarchiesi@0:     $default_id = $form_state['values']['options']['default_argument_type'];
danielebarchiesi@0:     $plugin = $this->get_plugin('argument default', $default_id);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       $plugin->options_validate($form['argument_default'][$default_id], $form_state, $form_state['values']['options']['argument_default'][$default_id]);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // summary plugin
danielebarchiesi@0:     $summary_id = $form_state['values']['options']['summary']['format'];
danielebarchiesi@0:     $plugin = $this->get_plugin('style', $summary_id);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       $plugin->options_validate($form['summary']['options'][$summary_id], $form_state, $form_state['values']['options']['summary']['options'][$summary_id]);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $validate_id = $form_state['values']['options']['validate']['type'];
danielebarchiesi@0:     $plugin = $this->get_plugin('argument validator', $validate_id);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       $plugin->options_validate($form['validate']['options'][$default_id], $form_state, $form_state['values']['options']['validate']['options'][$validate_id]);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function options_submit(&$form, &$form_state) {
danielebarchiesi@0:     if (empty($form_state['values']['options'])) {
danielebarchiesi@0:       return;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Let the plugins make submit modifications if necessary.
danielebarchiesi@0:     $default_id = $form_state['values']['options']['default_argument_type'];
danielebarchiesi@0:     $plugin = $this->get_plugin('argument default', $default_id);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       $options = &$form_state['values']['options']['argument_default'][$default_id];
danielebarchiesi@0:       $plugin->options_submit($form['argument_default'][$default_id], $form_state, $options);
danielebarchiesi@0:       // Copy the now submitted options to their final resting place so they get saved.
danielebarchiesi@0:       $form_state['values']['options']['default_argument_options'] = $options;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // summary plugin
danielebarchiesi@0:     $summary_id = $form_state['values']['options']['summary']['format'];
danielebarchiesi@0:     $plugin = $this->get_plugin('style', $summary_id);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       $options = &$form_state['values']['options']['summary']['options'][$summary_id];
danielebarchiesi@0:       $plugin->options_submit($form['summary']['options'][$summary_id], $form_state, $options);
danielebarchiesi@0:       // Copy the now submitted options to their final resting place so they get saved.
danielebarchiesi@0:       $form_state['values']['options']['summary_options'] = $options;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $validate_id = $form_state['values']['options']['validate']['type'];
danielebarchiesi@0:     $plugin = $this->get_plugin('argument validator', $validate_id);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       $options = &$form_state['values']['options']['validate']['options'][$validate_id];
danielebarchiesi@0:       $plugin->options_submit($form['validate']['options'][$validate_id], $form_state, $options);
danielebarchiesi@0:       // Copy the now submitted options to their final resting place so they get saved.
danielebarchiesi@0:       $form_state['values']['options']['validate_options'] = $options;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Clear out the content of title if it's not enabled.
danielebarchiesi@0:     $options =& $form_state['values']['options'];
danielebarchiesi@0:     if (empty($options['title_enable'])) {
danielebarchiesi@0:       $options['title'] = '';
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Provide a list of default behaviors for this argument if the argument
danielebarchiesi@0:    * is not present.
danielebarchiesi@0:    *
danielebarchiesi@0:    * Override this method to provide additional (or fewer) default behaviors.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_actions($which = NULL) {
danielebarchiesi@0:     $defaults = array(
danielebarchiesi@0:       'ignore' => array(
danielebarchiesi@0:         'title' => t('Display all results for the specified field'),
danielebarchiesi@0:         'method' => 'default_ignore',
danielebarchiesi@0:         'breadcrumb' => TRUE, // generate a breadcrumb to here
danielebarchiesi@0:       ),
danielebarchiesi@0:       'default' => array(
danielebarchiesi@0:         'title' => t('Provide default value'),
danielebarchiesi@0:         'method' => 'default_default',
danielebarchiesi@0:         'form method' => 'default_argument_form',
danielebarchiesi@0:         'has default argument' => TRUE,
danielebarchiesi@0:         'default only' => TRUE, // this can only be used for missing argument, not validation failure
danielebarchiesi@0:         'breadcrumb' => TRUE, // generate a breadcrumb to here
danielebarchiesi@0:       ),
danielebarchiesi@0:       'not found' => array(
danielebarchiesi@0:         'title' => t('Hide view'),
danielebarchiesi@0:         'method' => 'default_not_found',
danielebarchiesi@0:         'hard fail' => TRUE, // This is a hard fail condition
danielebarchiesi@0:       ),
danielebarchiesi@0:       'summary' => array(
danielebarchiesi@0:         'title' => t('Display a summary'),
danielebarchiesi@0:         'method' => 'default_summary',
danielebarchiesi@0:         'form method' => 'default_summary_form',
danielebarchiesi@0:         'style plugin' => TRUE,
danielebarchiesi@0:         'breadcrumb' => TRUE, // generate a breadcrumb to here
danielebarchiesi@0:       ),
danielebarchiesi@0:       'empty' => array(
danielebarchiesi@0:         'title' => t('Display contents of "No results found"'),
danielebarchiesi@0:         'method' => 'default_empty',
danielebarchiesi@0:         'breadcrumb' => TRUE, // generate a breadcrumb to here
danielebarchiesi@0:       ),
danielebarchiesi@0:       'access denied' => array(
danielebarchiesi@0:         'title' => t('Display "Access Denied"'),
danielebarchiesi@0:         'method' => 'default_access_denied',
danielebarchiesi@0:         'breadcrumb' => FALSE, // generate a breadcrumb to here
danielebarchiesi@0:       ),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     if ($this->view->display_handler->has_path()) {
danielebarchiesi@0:       $defaults['not found']['title'] = t('Show "Page not found"');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($which) {
danielebarchiesi@0:       if (!empty($defaults[$which])) {
danielebarchiesi@0:         return $defaults[$which];
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       return $defaults;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Provide a form for selecting the default argument when the
danielebarchiesi@0:    * default action is set to provide default argument.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_argument_form(&$form, &$form_state) {
danielebarchiesi@0:     $plugins = views_fetch_plugin_data('argument default');
danielebarchiesi@0:     $options = array();
danielebarchiesi@0: 
danielebarchiesi@0:     $form['default_argument_skip_url'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Skip default argument for view URL'),
danielebarchiesi@0:       '#default_value' => $this->options['default_argument_skip_url'],
danielebarchiesi@0:       '#description' => t('Select whether to include this default argument when constructing the URL for this view. Skipping default arguments is useful e.g. in the case of feeds.')
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['default_argument_type'] = array(
danielebarchiesi@0:       '#prefix' => '<div id="edit-options-default-argument-type-wrapper">',
danielebarchiesi@0:       '#suffix' => '</div>',
danielebarchiesi@0:       '#type' => 'select',
danielebarchiesi@0:       '#id' => 'edit-options-default-argument-type',
danielebarchiesi@0:       '#title' => t('Type'),
danielebarchiesi@0:       '#default_value' => $this->options['default_argument_type'],
danielebarchiesi@0: 
danielebarchiesi@0:       '#dependency' => array('radio:options[default_action]' => array('default')),
danielebarchiesi@0:       // Views custom key, moves this element to the appropriate container
danielebarchiesi@0:       // under the radio button.
danielebarchiesi@0:       '#argument_option' => 'default',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     foreach ($plugins as $id => $info) {
danielebarchiesi@0:       if (!empty($info['no ui'])) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0:       $plugin = $this->get_plugin('argument default', $id);
danielebarchiesi@0:       if ($plugin) {
danielebarchiesi@0:         if ($plugin->access() || $this->options['default_argument_type'] == $id) {
danielebarchiesi@0:           $form['argument_default']['#argument_option'] = 'default';
danielebarchiesi@0:           $form['argument_default'][$id] = array(
danielebarchiesi@0:             '#prefix' => '<div id="edit-options-argument-default-options-' . $id . '-wrapper">',
danielebarchiesi@0:             '#suffix' => '</div>',
danielebarchiesi@0:             '#id' => 'edit-options-argument-default-options-' . $id,
danielebarchiesi@0:             '#type' => 'item',
danielebarchiesi@0:             // Even if the plugin has no options add the key to the form_state.
danielebarchiesi@0:             '#input' => TRUE,
danielebarchiesi@0:             '#dependency' => array(
danielebarchiesi@0:               'radio:options[default_action]' => array('default'),
danielebarchiesi@0:               'edit-options-default-argument-type' => array($id)
danielebarchiesi@0:             ),
danielebarchiesi@0:             '#dependency_count' => 2,
danielebarchiesi@0:           );
danielebarchiesi@0:           $options[$id] = $info['title'];
danielebarchiesi@0:           $plugin->options_form($form['argument_default'][$id], $form_state);
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     asort($options);
danielebarchiesi@0:     $form['default_argument_type']['#options'] = $options;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Provide a form for selecting further summary options when the
danielebarchiesi@0:    * default action is set to display one.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_summary_form(&$form, &$form_state) {
danielebarchiesi@0:     $style_plugins = views_fetch_plugin_data('style');
danielebarchiesi@0:     $summary_plugins = array();
danielebarchiesi@0:     $format_options = array();
danielebarchiesi@0:     foreach ($style_plugins as $key => $plugin) {
danielebarchiesi@0:       if (isset($plugin['type']) && $plugin['type'] == 'summary') {
danielebarchiesi@0:         $summary_plugins[$key] = $plugin;
danielebarchiesi@0:         $format_options[$key] = $plugin['title'];
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $form['summary'] = array(
danielebarchiesi@0:       // Views custom key, moves this element to the appropriate container
danielebarchiesi@0:       // under the radio button.
danielebarchiesi@0:       '#argument_option' => 'summary',
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['summary']['sort_order'] = array(
danielebarchiesi@0:       '#type' => 'radios',
danielebarchiesi@0:       '#title' => t('Sort order'),
danielebarchiesi@0:       '#options' => array('asc' => t('Ascending'), 'desc' => t('Descending')),
danielebarchiesi@0:       '#default_value' => $this->options['summary']['sort_order'],
danielebarchiesi@0:       '#dependency' => array('radio:options[default_action]' => array('summary')),
danielebarchiesi@0:     );
danielebarchiesi@0:     $form['summary']['number_of_records'] = array(
danielebarchiesi@0:       '#type' => 'radios',
danielebarchiesi@0:       '#title' => t('Sort by'),
danielebarchiesi@0:       '#default_value' => $this->options['summary']['number_of_records'],
danielebarchiesi@0:       '#options' => array(
danielebarchiesi@0:         0 => $this->get_sort_name(),
danielebarchiesi@0:         1 => t('Number of records')
danielebarchiesi@0:       ),
danielebarchiesi@0:       '#dependency' => array('radio:options[default_action]' => array('summary')),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['summary']['format'] = array(
danielebarchiesi@0:       '#type' => 'radios',
danielebarchiesi@0:       '#title' => t('Format'),
danielebarchiesi@0:       '#options' => $format_options,
danielebarchiesi@0:       '#default_value' => $this->options['summary']['format'],
danielebarchiesi@0:       '#dependency' => array('radio:options[default_action]' => array('summary')),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     foreach ($summary_plugins as $id => $info) {
danielebarchiesi@0:       if (empty($info['uses options'])) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0:       $plugin = $this->get_plugin('style', $id);
danielebarchiesi@0:       if ($plugin) {
danielebarchiesi@0:         $form['summary']['options'][$id] = array(
danielebarchiesi@0:           '#prefix' => '<div id="edit-options-summary-options-' . $id . '-wrapper">',
danielebarchiesi@0:           '#suffix' => '</div>',
danielebarchiesi@0:           '#id' => 'edit-options-summary-options-' . $id,
danielebarchiesi@0:           '#type' => 'item',
danielebarchiesi@0:           '#input' => TRUE, // trick it into checking input to make #process run
danielebarchiesi@0:           '#dependency' => array(
danielebarchiesi@0:             'radio:options[default_action]' => array('summary'),
danielebarchiesi@0:             'radio:options[summary][format]' => array($id),
danielebarchiesi@0:           ),
danielebarchiesi@0:           '#dependency_count' => 2,
danielebarchiesi@0:         );
danielebarchiesi@0:         $options[$id] = $info['title'];
danielebarchiesi@0:         $plugin->options_form($form['summary']['options'][$id], $form_state);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Handle the default action, which means our argument wasn't present.
danielebarchiesi@0:    *
danielebarchiesi@0:    * Override this method only with extreme care.
danielebarchiesi@0:    *
danielebarchiesi@0:    * @return
danielebarchiesi@0:    *   A boolean value; if TRUE, continue building this view. If FALSE,
danielebarchiesi@0:    *   building the view will be aborted here.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_action($info = NULL) {
danielebarchiesi@0:     if (!isset($info)) {
danielebarchiesi@0:       $info = $this->default_actions($this->options['default_action']);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!$info) {
danielebarchiesi@0:       return FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($info['method args'])) {
danielebarchiesi@0:       return call_user_func_array(array(&$this, $info['method']), $info['method args']);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       return $this->{$info['method']}();
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * How to act if validation failes
danielebarchiesi@0:    */
danielebarchiesi@0:   function validate_fail() {
danielebarchiesi@0:     $info = $this->default_actions($this->options['validate']['fail']);
danielebarchiesi@0:     return $this->default_action($info);
danielebarchiesi@0:   }
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Default action: ignore.
danielebarchiesi@0:    *
danielebarchiesi@0:    * If an argument was expected and was not given, in this case, simply
danielebarchiesi@0:    * ignore the argument entirely.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_ignore() {
danielebarchiesi@0:     return TRUE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Default action: not found.
danielebarchiesi@0:    *
danielebarchiesi@0:    * If an argument was expected and was not given, in this case, report
danielebarchiesi@0:    * the view as 'not found' or hide it.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_not_found() {
danielebarchiesi@0:     // Set a failure condition and let the display manager handle it.
danielebarchiesi@0:     $this->view->build_info['fail'] = TRUE;
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Default action: access denied.
danielebarchiesi@0:    *
danielebarchiesi@0:    * If an argument was expected and was not given, in this case, report
danielebarchiesi@0:    * the view as 'access denied'.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_access_denied() {
danielebarchiesi@0:     $this->view->build_info['denied'] = TRUE;
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Default action: empty
danielebarchiesi@0:    *
danielebarchiesi@0:    * If an argument was expected and was not given, in this case, display
danielebarchiesi@0:    * the view's empty text
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_empty() {
danielebarchiesi@0:     // We return with no query; this will force the empty text.
danielebarchiesi@0:     $this->view->built = TRUE;
danielebarchiesi@0:     $this->view->executed = TRUE;
danielebarchiesi@0:     $this->view->result = array();
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * This just returns true. The view argument builder will know where
danielebarchiesi@0:    * to find the argument from.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_default() {
danielebarchiesi@0:     return TRUE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Determine if the argument is set to provide a default argument.
danielebarchiesi@0:    */
danielebarchiesi@0:   function has_default_argument() {
danielebarchiesi@0:     $info = $this->default_actions($this->options['default_action']);
danielebarchiesi@0:     return !empty($info['has default argument']);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Get a default argument, if available.
danielebarchiesi@0:    */
danielebarchiesi@0:   function get_default_argument() {
danielebarchiesi@0:     $plugin = $this->get_plugin('argument default');
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       return $plugin->get_argument();
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Process the summary arguments for display.
danielebarchiesi@0:    *
danielebarchiesi@0:    * For example, the validation plugin may want to alter an argument for use in
danielebarchiesi@0:    * the URL.
danielebarchiesi@0:    */
danielebarchiesi@0:   function process_summary_arguments(&$args) {
danielebarchiesi@0:     if ($this->options['validate']['type'] != 'none') {
danielebarchiesi@0:       if (isset($this->validator) || $this->validator = $this->get_plugin('argument validator')) {
danielebarchiesi@0:         $this->validator->process_summary_arguments($args);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Default action: summary.
danielebarchiesi@0:    *
danielebarchiesi@0:    * If an argument was expected and was not given, in this case, display
danielebarchiesi@0:    * a summary query.
danielebarchiesi@0:    */
danielebarchiesi@0:   function default_summary() {
danielebarchiesi@0:     $this->view->build_info['summary'] = TRUE;
danielebarchiesi@0:     $this->view->build_info['summary_level'] = $this->options['id'];
danielebarchiesi@0: 
danielebarchiesi@0:     // Change the display style to the summary style for this
danielebarchiesi@0:     // argument.
danielebarchiesi@0:     $this->view->plugin_name = $this->options['summary']['format'];
danielebarchiesi@0:     $this->view->style_options = $this->options['summary_options'];
danielebarchiesi@0: 
danielebarchiesi@0:     // Clear out the normal primary field and whatever else may have
danielebarchiesi@0:     // been added and let the summary do the work.
danielebarchiesi@0:     $this->query->clear_fields();
danielebarchiesi@0:     $this->summary_query();
danielebarchiesi@0: 
danielebarchiesi@0:     $by = $this->options['summary']['number_of_records'] ? 'num_records' : NULL;
danielebarchiesi@0:     $this->summary_sort($this->options['summary']['sort_order'], $by);
danielebarchiesi@0: 
danielebarchiesi@0:     // Summaries have their own sorting and fields, so tell the View not
danielebarchiesi@0:     // to build these.
danielebarchiesi@0:     $this->view->build_sort = $this->view->build_fields = FALSE;
danielebarchiesi@0:     return TRUE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Build the info for the summary query.
danielebarchiesi@0:    *
danielebarchiesi@0:    * This must:
danielebarchiesi@0:    * - add_groupby: group on this field in order to create summaries.
danielebarchiesi@0:    * - add_field: add a 'num_nodes' field for the count. Usually it will
danielebarchiesi@0:    *   be a count on $view->base_field
danielebarchiesi@0:    * - set_count_field: Reset the count field so we get the right paging.
danielebarchiesi@0:    *
danielebarchiesi@0:    * @return
danielebarchiesi@0:    *   The alias used to get the number of records (count) for this entry.
danielebarchiesi@0:    */
danielebarchiesi@0:   function summary_query() {
danielebarchiesi@0:     $this->ensure_my_table();
danielebarchiesi@0:     // Add the field.
danielebarchiesi@0:     $this->base_alias = $this->query->add_field($this->table_alias, $this->real_field);
danielebarchiesi@0: 
danielebarchiesi@0:     $this->summary_name_field();
danielebarchiesi@0:     return $this->summary_basics();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Add the name field, which is the field displayed in summary queries.
danielebarchiesi@0:    * This is often used when the argument is numeric.
danielebarchiesi@0:    */
danielebarchiesi@0:   function summary_name_field() {
danielebarchiesi@0:     // Add the 'name' field. For example, if this is a uid argument, the
danielebarchiesi@0:     // name field would be 'name' (i.e, the username).
danielebarchiesi@0: 
danielebarchiesi@0:     if (isset($this->name_table)) {
danielebarchiesi@0:       // if the alias is different then we're probably added, not ensured,
danielebarchiesi@0:       // so look up the join and add it instead.
danielebarchiesi@0:       if ($this->table_alias != $this->name_table) {
danielebarchiesi@0:         $j = views_get_table_join($this->name_table, $this->table);
danielebarchiesi@0:         if ($j) {
danielebarchiesi@0:           $join = clone $j;
danielebarchiesi@0:           $join->left_table = $this->table_alias;
danielebarchiesi@0:           $this->name_table_alias = $this->query->add_table($this->name_table, $this->relationship, $join);
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $this->name_table_alias = $this->query->ensure_table($this->name_table, $this->relationship);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $this->name_table_alias = $this->table_alias;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (isset($this->name_field)) {
danielebarchiesi@0:       $this->name_alias = $this->query->add_field($this->name_table_alias, $this->name_field);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $this->name_alias = $this->base_alias;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Some basic summary behavior that doesn't need to be repeated as much as
danielebarchiesi@0:    * code that goes into summary_query()
danielebarchiesi@0:    */
danielebarchiesi@0:   function summary_basics($count_field = TRUE) {
danielebarchiesi@0:     // Add the number of nodes counter
danielebarchiesi@0:     $distinct = ($this->view->display_handler->get_option('distinct') && empty($this->query->no_distinct));
danielebarchiesi@0: 
danielebarchiesi@0:     $count_alias = $this->query->add_field($this->query->base_table, $this->query->base_field, 'num_records',
danielebarchiesi@0:                                            array('count' => TRUE, 'distinct' => $distinct));
danielebarchiesi@0:     $this->query->add_groupby($this->name_alias);
danielebarchiesi@0: 
danielebarchiesi@0:     if ($count_field) {
danielebarchiesi@0:       $this->query->set_count_field($this->table_alias, $this->real_field);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $this->count_alias = $count_alias;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Sorts the summary based upon the user's selection. The base variant of
danielebarchiesi@0:    * this is usually adequte.
danielebarchiesi@0:    *
danielebarchiesi@0:    * @param $order
danielebarchiesi@0:    *   The order selected in the UI.
danielebarchiesi@0:    */
danielebarchiesi@0:   function summary_sort($order, $by = NULL) {
danielebarchiesi@0:     $this->query->add_orderby(NULL, NULL, $order, (!empty($by) ? $by : $this->name_alias));
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Provide the argument to use to link from the summary to the next level;
danielebarchiesi@0:    * this will be called once per row of a summary, and used as part of
danielebarchiesi@0:    * $view->get_url().
danielebarchiesi@0:    *
danielebarchiesi@0:    * @param $data
danielebarchiesi@0:    *   The query results for the row.
danielebarchiesi@0:    */
danielebarchiesi@0:   function summary_argument($data) {
danielebarchiesi@0:     return $data->{$this->base_alias};
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Provides the name to use for the summary. By default this is just
danielebarchiesi@0:    * the name field.
danielebarchiesi@0:    *
danielebarchiesi@0:    * @param $data
danielebarchiesi@0:    *   The query results for the row.
danielebarchiesi@0:    */
danielebarchiesi@0:   function summary_name($data) {
danielebarchiesi@0:     $value = $data->{$this->name_alias};
danielebarchiesi@0:     if (empty($value) && !empty($this->definition['empty field name'])) {
danielebarchiesi@0:       $value = $this->definition['empty field name'];
danielebarchiesi@0:     }
danielebarchiesi@0:     return check_plain($value);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Set up the query for this argument.
danielebarchiesi@0:    *
danielebarchiesi@0:    * The argument sent may be found at $this->argument.
danielebarchiesi@0:    */
danielebarchiesi@0:   function query($group_by = FALSE) {
danielebarchiesi@0:     $this->ensure_my_table();
danielebarchiesi@0:     $this->query->add_where(0, "$this->table_alias.$this->real_field", $this->argument);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Get the title this argument will assign the view, given the argument.
danielebarchiesi@0:    *
danielebarchiesi@0:    * This usually needs to be overridden to provide a proper title.
danielebarchiesi@0:    */
danielebarchiesi@0:   function title() {
danielebarchiesi@0:     return check_plain($this->argument);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Called by the view object to get the title. This may be set by a
danielebarchiesi@0:    * validator so we don't necessarily call through to title().
danielebarchiesi@0:    */
danielebarchiesi@0:   function get_title() {
danielebarchiesi@0:     if (isset($this->validated_title)) {
danielebarchiesi@0:       return $this->validated_title;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       return $this->title();
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Validate that this argument works. By default, all arguments are valid.
danielebarchiesi@0:    */
danielebarchiesi@0:   function validate_arg($arg) {
danielebarchiesi@0:     // By using % in URLs, arguments could be validated twice; this eases
danielebarchiesi@0:     // that pain.
danielebarchiesi@0:     if (isset($this->argument_validated)) {
danielebarchiesi@0:       return $this->argument_validated;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($this->is_exception($arg)) {
danielebarchiesi@0:       return $this->argument_validated = TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($this->options['validate']['type'] == 'none') {
danielebarchiesi@0:       return $this->argument_validated = $this->validate_argument_basic($arg);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $plugin = $this->get_plugin('argument validator');
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       return $this->argument_validated = $plugin->validate_argument($arg);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // If the plugin isn't found, fall back to the basic validation path:
danielebarchiesi@0:     return $this->argument_validated = $this->validate_argument_basic($arg);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Called by the menu system to validate an argument.
danielebarchiesi@0:    *
danielebarchiesi@0:    * This checks to see if this is a 'soft fail', which means that if the
danielebarchiesi@0:    * argument fails to validate, but there is an action to take anyway,
danielebarchiesi@0:    * then validation cannot actually fail.
danielebarchiesi@0:    */
danielebarchiesi@0:   function validate_argument($arg) {
danielebarchiesi@0:     $validate_info = $this->default_actions($this->options['validate']['fail']);
danielebarchiesi@0:     if (empty($validate_info['hard fail'])) {
danielebarchiesi@0:       return TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $rc = $this->validate_arg($arg);
danielebarchiesi@0: 
danielebarchiesi@0:     // If the validator has changed the validate fail condition to a
danielebarchiesi@0:     // soft fail, deal with that:
danielebarchiesi@0:     $validate_info = $this->default_actions($this->options['validate']['fail']);
danielebarchiesi@0:     if (empty($validate_info['hard fail'])) {
danielebarchiesi@0:       return TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return $rc;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Provide a basic argument validation.
danielebarchiesi@0:    *
danielebarchiesi@0:    * This can be overridden for more complex types; the basic
danielebarchiesi@0:    * validator only checks to see if the argument is not NULL
danielebarchiesi@0:    * or is numeric if the definition says it's numeric.
danielebarchiesi@0:    */
danielebarchiesi@0:   function validate_argument_basic($arg) {
danielebarchiesi@0:     if (!isset($arg) || $arg === '') {
danielebarchiesi@0:       return FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($this->definition['numeric']) && !isset($this->options['break_phrase']) && !is_numeric($arg)) {
danielebarchiesi@0:       return FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return TRUE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Set the input for this argument
danielebarchiesi@0:    *
danielebarchiesi@0:    * @return TRUE if it successfully validates; FALSE if it does not.
danielebarchiesi@0:    */
danielebarchiesi@0:   function set_argument($arg) {
danielebarchiesi@0:     $this->argument = $arg;
danielebarchiesi@0:     return $this->validate_arg($arg);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Get the value of this argument.
danielebarchiesi@0:    */
danielebarchiesi@0:   function get_value() {
danielebarchiesi@0:     // If we already processed this argument, we're done.
danielebarchiesi@0:     if (isset($this->argument)) {
danielebarchiesi@0:       return $this->argument;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Otherwise, we have to pretend to process ourself to find the value.
danielebarchiesi@0:     $value = NULL;
danielebarchiesi@0:     // Find the position of this argument within the view.
danielebarchiesi@0:     $position = 0;
danielebarchiesi@0:     foreach ($this->view->argument as $id => $argument) {
danielebarchiesi@0:       if ($id == $this->options['id']) {
danielebarchiesi@0:         break;
danielebarchiesi@0:       }
danielebarchiesi@0:       $position++;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $arg = isset($this->view->args[$position]) ? $this->view->args[$position] : NULL;
danielebarchiesi@0:     $this->position = $position;
danielebarchiesi@0: 
danielebarchiesi@0:     // Clone ourselves so that we don't break things when we're really
danielebarchiesi@0:     // processing the arguments.
danielebarchiesi@0:     $argument = clone $this;
danielebarchiesi@0:     if (!isset($arg) && $argument->has_default_argument()) {
danielebarchiesi@0:       $arg = $argument->get_default_argument();
danielebarchiesi@0: 
danielebarchiesi@0:       // remember that this argument was computed, not passed on the URL.
danielebarchiesi@0:       $this->is_default = TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0:     // Set the argument, which will also validate that the argument can be set.
danielebarchiesi@0:     if ($argument->set_argument($arg)) {
danielebarchiesi@0:       $value = $argument->argument;
danielebarchiesi@0:     }
danielebarchiesi@0:     unset($argument);
danielebarchiesi@0:     return $value;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Export handler for summary export.
danielebarchiesi@0:    *
danielebarchiesi@0:    * Arguments can have styles for the summary view. This special export
danielebarchiesi@0:    * handler makes sure this works properly.
danielebarchiesi@0:    */
danielebarchiesi@0:   function export_summary($indent, $prefix, $storage, $option, $definition, $parents) {
danielebarchiesi@0:     $output = '';
danielebarchiesi@0:     $name = $this->options['summary'][$option];
danielebarchiesi@0:     $options = $this->options['summary_options'];
danielebarchiesi@0: 
danielebarchiesi@0:     $plugin = views_get_plugin('style', $name);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       $plugin->init($this->view, $this->view->display_handler->display, $options);
danielebarchiesi@0:       // Write which plugin to use.
danielebarchiesi@0:       $output .= $indent . $prefix . "['summary']['$option'] = '$name';\n";
danielebarchiesi@0: 
danielebarchiesi@0:       // Pass off to the plugin to export itself.
danielebarchiesi@0:       $output .= $plugin->export_options($indent, $prefix . "['summary_options']");
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return $output;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Export handler for validation export.
danielebarchiesi@0:    *
danielebarchiesi@0:    * Arguments use validation plugins. This special export handler makes sure
danielebarchiesi@0:    * this works properly.
danielebarchiesi@0:    */
danielebarchiesi@0:   function export_validation($indent, $prefix, $storage, $option, $definition, $parents) {
danielebarchiesi@0:     $output = '';
danielebarchiesi@0:     $name = $this->options['validate'][$option];
danielebarchiesi@0:     $options = $this->options['validate_options'];
danielebarchiesi@0: 
danielebarchiesi@0:     $plugin = views_get_plugin('argument validator', $name);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       $plugin->init($this->view, $this->display, $options);
danielebarchiesi@0:       // Write which plugin to use.
danielebarchiesi@0:       $output .= $indent . $prefix . "['validate']['$option'] = '$name';\n";
danielebarchiesi@0: 
danielebarchiesi@0:       // Pass off to the plugin to export itself.
danielebarchiesi@0:       $output .= $plugin->export_options($indent, $prefix . "['validate_options']");
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return $output;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Generic plugin export handler.
danielebarchiesi@0:    *
danielebarchiesi@0:    * Since style and validation plugins have their own export handlers, this
danielebarchiesi@0:    * one is currently only used for default argument plugins.
danielebarchiesi@0:    */
danielebarchiesi@0:   function export_plugin($indent, $prefix, $storage, $option, $definition, $parents) {
danielebarchiesi@0:     $output = '';
danielebarchiesi@0:     if ($option == 'default_argument_type') {
danielebarchiesi@0:       $type = 'argument default';
danielebarchiesi@0:       $option_name = 'default_argument_options';
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $plugin = $this->get_plugin($type);
danielebarchiesi@0:     $name = $this->options[$option];
danielebarchiesi@0: 
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       // Write which plugin to use.
danielebarchiesi@0:       $output .= $indent . $prefix . "['$option'] = '$name';\n";
danielebarchiesi@0: 
danielebarchiesi@0:       // Pass off to the plugin to export itself.
danielebarchiesi@0:       $output .= $plugin->export_options($indent, $prefix . "['$option_name']");
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return $output;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Get the display or row plugin, if it exists.
danielebarchiesi@0:    */
danielebarchiesi@0:   function get_plugin($type = 'argument default', $name = NULL) {
danielebarchiesi@0:     $options = array();
danielebarchiesi@0:     switch ($type) {
danielebarchiesi@0:       case 'argument default':
danielebarchiesi@0:         $plugin_name = $this->options['default_argument_type'];
danielebarchiesi@0:         $options_name = 'default_argument_options';
danielebarchiesi@0:         break;
danielebarchiesi@0:       case 'argument validator':
danielebarchiesi@0:         $plugin_name = $this->options['validate']['type'];
danielebarchiesi@0:         $options_name = 'validate_options';
danielebarchiesi@0:         break;
danielebarchiesi@0:       case 'style':
danielebarchiesi@0:         $plugin_name = $this->options['summary']['format'];
danielebarchiesi@0:         $options_name = 'summary_options';
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!$name) {
danielebarchiesi@0:       $name = $plugin_name;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // we only fetch the options if we're fetching the plugin actually
danielebarchiesi@0:     // in use.
danielebarchiesi@0:     if ($name == $plugin_name) {
danielebarchiesi@0:       $options = $this->options[$options_name];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $plugin = views_get_plugin($type, $name);
danielebarchiesi@0:     if ($plugin) {
danielebarchiesi@0:       // Style plugins expects different parameters as argument related plugins.
danielebarchiesi@0:       if ($type == 'style') {
danielebarchiesi@0:         $plugin->init($this->view, $this->view->display_handler->display, $options);
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $plugin->init($this->view, $this, $options);
danielebarchiesi@0:       }
danielebarchiesi@0:       return $plugin;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Return a description of how the argument would normally be sorted.
danielebarchiesi@0:    *
danielebarchiesi@0:    * Subclasses should override this to specify what the default sort order of
danielebarchiesi@0:    * their argument is (e.g. alphabetical, numeric, date).
danielebarchiesi@0:    */
danielebarchiesi@0:   function get_sort_name() {
danielebarchiesi@0:     return t('Default sort', array(), array('context' => 'Sort order'));
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * A special handler to take the place of missing or broken handlers.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @ingroup views_argument_handlers
danielebarchiesi@0:  */
danielebarchiesi@0: class views_handler_argument_broken extends views_handler_argument {
danielebarchiesi@0:   function ui_name($short = FALSE) {
danielebarchiesi@0:     return t('Broken/missing handler');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function ensure_my_table() { /* No table to ensure! */ }
danielebarchiesi@0:   function query($group_by = FALSE) { /* No query to run */ }
danielebarchiesi@0:   function options_form(&$form, &$form_state) {
danielebarchiesi@0:     $form['markup'] = array(
danielebarchiesi@0:       '#markup' => '<div class="form-item description">' . t('The handler for this item is broken or missing and cannot be used. If a module provided the handler and was disabled, re-enabling the module may restore it. Otherwise, you should probably delete this item.') . '</div>',
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Determine if the handler is considered 'broken'
danielebarchiesi@0:    */
danielebarchiesi@0:   function broken() { return TRUE; }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @}
danielebarchiesi@0:  */