class views_handler_argument_formula

Same name in other branches
  1. 7.x-3.x handlers/views_handler_argument_formula.inc \views_handler_argument_formula

Abstract argument handler for simple formulae.

Child classes of this object should implement summary_argument, at least.

Definition terms:

  • formula: The formula to use for this handler.

Hierarchy

Expanded class hierarchy of views_handler_argument_formula

Related topics

Handlers for arguments
1 string reference to 'views_handler_argument_formula'
views_views_handlers in includes/handlers.inc
Implementation of hook_views_handlers() to register all of the basic handlers views uses.

File

handlers/views_handler_argument_formula.inc, line 12

View source 
class views_handler_argument_formula extends views_handler_argument {
    var $formula = NULL;
    
    /**
     * Constructor
     */
    function construct() {
        parent::construct();
        if (!empty($this->definition['formula'])) {
            $this->formula = $this->definition['formula'];
        }
    }
    function get_formula() {
        return str_replace('***table***', $this->table_alias, $this->formula);
    }
    
    /**
     * Build the summary query based on a formula
     */
    function summary_query() {
        $this->ensure_my_table();
        // Now that our table is secure, get our formula.
        $formula = $this->get_formula();
        // Add the field.
        $this->base_alias = $this->name_alias = $this->query
            ->add_field(NULL, $formula, $this->field);
        $this->query
            ->set_count_field(NULL, $formula, $this->field);
        return $this->summary_basics(FALSE);
    }
    
    /**
     * Build the query based upon the formula
     */
    function query() {
        $this->ensure_my_table();
        // Now that our table is secure, get our formula.
        $formula = $this->get_formula();
        $this->query
            ->add_where(0, "{$formula} = '%s'", $this->argument);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
views_handler::$handler_type property The type of the handler, for example filter/footer/field.
views_handler::$query property Where the $query object will reside: 6
views_handler::$view property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access function Check whether current user has access to this handler. 6
views_handler::admin_summary function Provide text for the administrative summary 4
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. 		6
views_handler::can_expose function Determine if a handler can be exposed. 2
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used
a lot. 		8
views_handler::exposed_form function Render our chunk of the exposed handler form when selecting 2
views_handler::exposed_info function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit function Submit the exposed handler form
views_handler::exposed_validate function Validate the exposed handler form 4
views_handler::expose_form function Overridable form for exposed handler options.
views_handler::expose_form_left function 2
views_handler::expose_form_right function 2
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped
on. 		2
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. 1
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options. 1
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::has_extra_options function If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. 		1
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements
to let users modify the view.
views_handler::pre_query function Run before the view is built. 1
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. 1
views_handler::ui_name function Return a string representing this handler's name in the UI. 10
views_handler::use_group_by function Provides the handler some groupby. 2
views_handler::validate function Validates the handler against the complete View. 1
views_handler_argument::$name_field property
views_handler_argument::default_action function Handle the default action, which means our argument wasn't present.
views_handler_argument::default_actions function Provide a list of default behaviors for this argument if the argument
is not present. 		3
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. 		1
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::export_plugin function Special handling for the style export. 1
views_handler_argument::export_style function Special handling for the style export.
views_handler_argument::get_default_argument function Get a default argument, if available. 1
views_handler_argument::get_plugin function Get the display or row plugin, if it exists.
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 2
views_handler_argument::is_wildcard 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_form function Overrides views_handler::options_form 7
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::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler::option_definition 5
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. 		2
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(). 		4
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. 		10
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_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. 13
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_argument_basic function Provide a basic argument validation. 1
views_handler_argument::validate_fail function How to act if validation failes
views_handler_argument::wildcard_title function
views_handler_argument_formula::$formula property
views_handler_argument_formula::construct function Constructor Overrides views_handler_argument::construct 6
views_handler_argument_formula::get_formula function
views_handler_argument_formula::query function Build the query based upon the formula Overrides views_handler_argument::query
views_handler_argument_formula::summary_query function Build the summary query based on a formula Overrides views_handler_argument::summary_query
views_object::$definition property Handler's definition
views_object::$options property Except for displays, options for the object will be held here. 1
views_object::destroy function 2
views_object::export_option function 1
views_object::export_options function
views_object::options function Set default options on this object. Called by the constructor in a
complex chain to deal with backward compatibility. 		1
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