Base class for arguments.
The basic argument works for very simple arguments such as nid and uid
Definition terms for this handler:
- name field: The field to use for the name to use in the summary, which is the displayed output. For example, for the node: nid argument, the argument itself is the nid, but node.title is displayed.
- name table: The table to use for the name, should it not be in the same table as the argument.
- empty field name: For arguments that can have no value, such as taxonomy which can have "no term", this is the string which will be displayed for this lack of value. Be sure to use t().
- validate type: A little used string to allow an argument to restrict which validator is available to just one. Use the validator ID. This probably should not be used at all, and may disappear or change.
- numeric: If set to TRUE this field is numeric and will use %d instead of %s in queries.
Hierarchy
- class views_object
- class views_handler
- class views_handler_argument
- class views_handler
Expanded class hierarchy of views_handler_argument
Related topics
File
- core/
modules/ views/ handlers/ views_handler_argument.inc, line 37 - @todo.
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_object:: |
function | ||
views_object:: |
public | function | Unpacks each handler to store translatable texts. |
views_object:: |
public | function | Unpack a single option definition. |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Let the handler know what its full definition is. | |
views_object:: |
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:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
function | ||
views_handler_argument:: |
function | How to act if validation fails. | |
views_handler_argument:: |
function | Provide a basic argument validation. | |
views_handler_argument:: |
function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
function | Determine if the argument can generate a breadcrumb | |
views_handler_argument:: |
function | Get the title this argument will assign the view, given the argument. | |
views_handler_argument:: |
function | Sorts the summary based upon the user's selection. The base variant of this is usually adequate. | |
views_handler_argument:: |
function | Build the info for the summary query. | |
views_handler_argument:: |
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:: |
function | Provides the name to use for the summary. By default this is just the name field. | |
views_handler_argument:: |
function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query() | |
views_handler_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:: |
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:: |
function | Set the input for this argument | |
views_handler_argument:: |
function | Set up the query for this argument. | |
views_handler_argument:: |
function | Process the summary arguments for display. | |
views_handler_argument:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler:: |
|
views_handler_argument:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
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:: |
|
views_handler_argument:: |
function |
Build the options form. Overrides views_handler:: |
|
views_handler_argument:: |
function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
function | ||
views_handler_argument:: |
function |
init the handler with necessary data. Overrides views_handler:: |
|
views_handler_argument:: |
function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
function | Get the value of this argument. | |
views_handler_argument:: |
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:: |
function | Return a description of how the argument would normally be sorted. | |
views_handler_argument:: |
function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
function | Get a default argument, if available. | |
views_handler_argument:: |
function | ||
views_handler_argument:: |
function | Provide a form for selecting further summary options when the default action is set to display one. | |
views_handler_argument:: |
function | Default action: summary. | |
views_handler_argument:: |
function | Default action: not found. | |
views_handler_argument:: |
function | Default action: ignore. | |
views_handler_argument:: |
function | Default action: empty | |
views_handler_argument:: |
function | This just returns true. The view argument builder will know where to find the argument from. | |
views_handler_argument:: |
function | Provide a form for selecting the default argument when the default action is set to provide default argument. | |
views_handler_argument:: |
function | Provide a list of default behaviors for this argument if the argument is not present. | |
views_handler_argument:: |
function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
function | Default action: access denied. | |
views_handler_argument:: |
function |
Constructor Overrides views_object:: |
|
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
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:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
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:: |
function | Provide a form for aggregation settings. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
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:: |
function | Provide a form for setting options. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
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:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Determine if a handler can be exposed. | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | |
views_handler:: |
function | Provide text for the administrative summary | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
public | property | The Views name of the table on which this handler effects. |