class views_handler_argument_null

  1. 3.x handlers/views_handler_argument_null.inc views_handler_argument_null
  2. 2.x handlers/views_handler_argument_null.inc views_handler_argument_null

Argument handler that ignores the argument.

Hierarchy

Expanded class hierarchy of views_handler_argument_null

Related topics

2 string references to 'views_handler_argument_null'

File

handlers/views_handler_argument_null.inc, line 13
Definition of views_handler_argument_null.

View source
class views_handler_argument_null extends views_handler_argument {
  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.
   */
  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.
   */
  function default_actions($which = NULL) {
    if ($which) {
      if (in_array($which, array('ignore', 'not found', 'empty', 'default'))) {
        return parent::default_actions($which);
      }
      return;
    }
    $actions = parent::default_actions();
    unset($actions['summary asc']);
    unset($actions['summary desc']);
    return $actions;
  }

  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.
   */
  function query($group_by = FALSE) {
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::accept_exposed_input function Take input from exposed handlers and assign to this handler, if necessary.
views_handler::access function Check whether current user has access to this handler.
views_handler::admin_summary function Provide text for the administrative summary
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found.
views_handler::can_expose function Determine if a handler can be exposed.
views_handler::case_transform function Transform a string by a certain method.
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used a lot.
views_handler::exposed_form function Render our chunk of the exposed handler form when selecting
views_handler::exposed_info function Get information about the exposed form for the form renderer.
views_handler::exposed_submit function Submit the exposed handler form
views_handler::exposed_validate function Validate the exposed handler form
views_handler::expose_form function Form for exposed handler options.
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped on.
views_handler::expose_submit 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 function Validate the options form.
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options.
views_handler::extra_options_submit 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 function Validate the options form.
views_handler::get_field function Shortcut to get a handler's raw field value.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::groupby_form function Provide a form for aggregation settings.
views_handler::groupby_form_submit 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::has_extra_options function If a handler has 'extra options' it will get a little settings widget and another form called extra_options.
views_handler::is_a_group function Returns TRUE if the exposed filter works like a grouped filter.
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.
views_handler::placeholder function Provides a unique placeholders for handlers.
views_handler::post_execute function Run after the view is executed, before the result is cached.
views_handler::pre_query function Run before the view is built.
views_handler::sanitize_value function Sanitize the value for output.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button function Shortcut to display the expose/hide button.
views_handler::show_expose_form function Shortcut to display the exposed options form.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there.
views_handler::ui_name function Return a string representing this handler's name in the UI.
views_handler::use_group_by function Provides the handler some groupby.
views_handler::validate function Validates the handler against the complete View.
views_handler_argument::construct function Constructor Overrides views_object::construct
views_handler_argument::default_access_denied function Default action: access denied.
views_handler_argument::default_action function Handle the default action, which means our argument wasn't present.
views_handler_argument::default_argument_form function Provide a form for selecting the default argument when the default action is set to provide default argument.
views_handler_argument::default_default function This just returns true. The view argument builder will know where to find the argument from.
views_handler_argument::default_empty function Default action: empty
views_handler_argument::default_ignore function Default action: ignore.
views_handler_argument::default_not_found function Default action: not found.
views_handler_argument::default_summary function Default action: summary.
views_handler_argument::default_summary_form function Provide a form for selecting further summary options when the default action is set to display one.
views_handler_argument::exception_title function
views_handler_argument::export_plugin function Generic plugin export handler.
views_handler_argument::export_summary function Export handler for summary export.
views_handler_argument::export_validation function Export handler for validation export.
views_handler_argument::get_default_argument function Get a default argument, if available.
views_handler_argument::get_plugin function Get the display or row plugin, if it exists.
views_handler_argument::get_sort_name function Return a description of how the argument would normally be sorted.
views_handler_argument::get_title function Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title().
views_handler_argument::get_value function Get the value of this argument.
views_handler_argument::has_default_argument function Determine if the argument is set to provide a default argument.
views_handler_argument::init function init the handler with necessary data. Overrides views_handler::init
views_handler_argument::is_exception function
views_handler_argument::needs_style_plugin function Determine if the argument needs a style plugin. Overrides views_handler::needs_style_plugin
views_handler_argument::options_submit 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 function Validate the options form. Overrides views_handler::options_validate
views_handler_argument::process_summary_arguments function Process the summary arguments for display.
views_handler_argument::set_argument function Set the input for this argument
views_handler_argument::set_breadcrumb function Give an argument the opportunity to modify the breadcrumb, if it wants. This only gets called on displays where a breadcrumb is actually used.
views_handler_argument::summary_argument function Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->get_url().
views_handler_argument::summary_basics function Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query()
views_handler_argument::summary_name function Provides the name to use for the summary. By default this is just the name field.
views_handler_argument::summary_name_field function Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric.
views_handler_argument::summary_query function Build the info for the summary query.
views_handler_argument::summary_sort function Sorts the summary based upon the user's selection. The base variant of this is usually adequte.
views_handler_argument::title function Get the title this argument will assign the view, given the argument.
views_handler_argument::uses_breadcrumb function Determine if the argument can generate a breadcrumb
views_handler_argument::validate_arg function Validate that this argument works. By default, all arguments are valid.
views_handler_argument::validate_argument function Called by the menu system to validate an argument.
views_handler_argument::validate_fail function How to act if validation failes
views_handler_argument_null::default_actions function Override default_actions() to remove actions that don't make sense for a null argument. Overrides views_handler_argument::default_actions
views_handler_argument_null::options_form function Override options_form() so that only the relevant options are displayed to the user. Overrides views_handler_argument::options_form
views_handler_argument_null::option_definition function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides views_handler_argument::option_definition
views_handler_argument_null::query function Override the behavior of query() to prevent the query from being changed in any way. Overrides views_handler_argument::query
views_handler_argument_null::validate_argument_basic function Provide a basic argument validation. Overrides views_handler_argument::validate_argument_basic
views_object::destroy function
views_object::export_option function
views_object::export_options function
views_object::export_option_always function Always exports the option, regardless of the default value.
views_object::options Deprecated function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function