views_handler_argument_null.inc

<?php


/**
 * @file
 * Definition of views_handler_argument_null.
 */

/**
 * Argument handler that ignores the argument.
 *
 * @ingroup views_argument_handlers
 */
class views_handler_argument_null extends views_handler_argument {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['must_not_be'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * Override options_form() so that only the relevant options
     * are displayed to the user.
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $form['must_not_be'] = array(
            '#type' => 'checkbox',
            '#title' => t('Fail basic validation if any argument is given'),
            '#default_value' => !empty($this->options['must_not_be']),
            '#description' => t('By checking this field, you can use this to make sure views with more arguments than necessary fail validation.'),
            '#fieldset' => 'more',
        );
        unset($form['exception']);
    }
    
    /**
     * Override default_actions() to remove actions that don't
     * make sense for a null argument.
     */
    public function default_actions($which = NULL) {
        if ($which) {
            if (in_array($which, array(
                'ignore',
                'not found',
                'empty',
                'default',
                'access denied',
            ))) {
                return parent::default_actions($which);
            }
            return;
        }
        $actions = parent::default_actions();
        unset($actions['summary asc']);
        unset($actions['summary desc']);
        return $actions;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validate_argument_basic($arg) {
        if (!empty($this->options['must_not_be'])) {
            return !isset($arg);
        }
        return parent::validate_argument_basic($arg);
    }
    
    /**
     * Override the behavior of query() to prevent the query
     * from being changed in any way.
     */
    public function query($group_by = FALSE) {
    }

}