PHPXRef 0.7 : Drupal 6 (yi-drupal) : Detail view of views_handler

Class: views_handler_argument - X-Ref

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.

construct() X-Ref

Constructor

init(&$view, &$options) X-Ref

No description

set_breadcrumb(&$breadcrumb) X-Ref

Give an argument the opportunity to modify the breadcrumb, if it wants.
This only gets called on displays where a breadcrumb is actually used.

The breadcrumb will be in the form of an array, with the keys being
the path and the value being the already sanitized title of the path.

uses_breadcrumb() X-Ref

Determine if the argument can generate a breadcrumb

return: TRUE/FALSE

is_wildcard($arg = NULL) X-Ref

No description

wildcard_title() X-Ref

No description

needs_style_plugin() X-Ref

Determine if the argument needs a style plugin.

return: TRUE/FALSE

option_definition() X-Ref

No description

options_form(&$form, &$form_state) X-Ref

No description

default_actions($which = NULL) X-Ref

Provide a list of default behaviors for this argument if the argument
is not present.

Override this method to provide additional (or fewer) default behaviors.

default_argument_form(&$form, &$form_state) X-Ref

Provide a form for selecting the default argument when the
default action is set to provide default argument.

default_action($info = NULL) X-Ref

Handle the default action, which means our argument wasn't present.

Override this method only with extreme care.

return:

validate_fail() X-Ref

How to act if validation failes

default_ignore() X-Ref

Default action: ignore.

If an argument was expected and was not given, in this case, simply
ignore the argument entirely.

default_not_found() X-Ref

Default action: not found.

If an argument was expected and was not given, in this case, report
the view as 'not found' or hide it.

default_empty() X-Ref

Default action: empty

If an argument was expected and was not given, in this case, display
the view's empty text

default_default() X-Ref

This just returns true. The view argument builder will know where
to find the argument from.

has_default_argument() X-Ref

Determine if the argument is set to provide a default argument.

get_default_argument() X-Ref

Get a default argument, if available.

default_summary($order) X-Ref

Default action: summary.

If an argument was expected and was not given, in this case, display
a summary query.

summary_query() X-Ref

Build the info for the summary query.

This must:
- add_groupby: group on this field in order to create summaries.
- add_field: add a 'num_nodes' field for the count. Usually it will
be a count on $view->base_field
- set_count_field: Reset the count field so we get the right paging.

return:

summary_name_field() X-Ref

Add the name field, which is the field displayed in summary queries.
This is often used when the argument is numeric.

summary_basics($count_field = TRUE) X-Ref

Some basic summary behavior that doesn't need to be repeated as much as
code that goes into summary_query()

summary_sort($order) X-Ref

Sorts the summary based upon the user's selection. The base variant of
this is usually adequte.

param: $order

summary_argument($data) X-Ref

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().

param: $data

summary_name($data) X-Ref

Provides the name to use for the summary. By default this is just
the name field.

param: $data

query() X-Ref

Set up the query for this argument.

The argument sent may be found at $this->argument.

title() X-Ref

Get the title this argument will assign the view, given the argument.

This usually needs to be overridden to provide a proper title.

get_title() X-Ref

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().

validate_arg($arg) X-Ref

Validate that this argument works. By default, all arguments are valid.

validate_argument($arg) X-Ref

Called by the menu system to validate an argument.

This checks to see if this is a 'soft fail', which means that if the
argument fails to validate, but there is an action to take anyway,
then validation cannot actually fail.

validate_argument_basic($arg) X-Ref

Provide a basic argument validation.

This can be overridden for more complex types; the basic
validator only checks to see if the argument is not NULL
or is numeric if the definition says it's numeric.

set_argument($arg) X-Ref

Set the input for this argument

return: TRUE if it successfully validates; FALSE if it does not.

get_value() X-Ref

Get the value of this argument.

Class: views_handler_argument_broken - X-Ref

A special handler to take the place of missing or broken handlers.

ui_name($short = FALSE) X-Ref

No description

ensure_my_table() X-Ref

No description

query() X-Ref

No description