Base handler, from which all the other handlers are derived. It creates a common interface to create consistency amongst handlers and data.
This class would be abstract in PHP5, but PHP4 doesn't understand that.
Definition terms:
- table: The actual table this uses; only specify if different from the table this is attached to.
- real field: The actual field this uses; only specify if different from the field this item is attached to.
- group: A text string representing the 'group' this item is attached to, for display in the UI. Examples: "Node", "Taxonomy", "Comment", "User", etc. This may be inherited from the parent definition or the 'table' definition.
- title: The title for this handler in the UI. This may be inherited from the parent definition or the 'table' definition.
- help: A more informative string to give to the user to explain what this field/handler is or does.
- access callback: If this field should have access control, this could be a function to use. 'user_access' is a common function to use here. If not specified, no access control is provided.
- access arguments: An array of arguments for the access callback.
Hierarchy
- class views_object
- class views_handler
Expanded class hierarchy of views_handler
File
- core/
modules/ views/ includes/ handlers.inc, line 33 - Defines the various handler objects to help build and display views.
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
function | init the handler with necessary data. | |
views_handler:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_object:: |
|
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Build 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 | Provides the handler some groupby. | |
views_handler:: |
function | Provide a form for aggregation settings. | |
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 | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Provide a form for setting options. | |
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 | Determine if a handler can be exposed. | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
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 | Validate the exposed handler form | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Form for exposed handler options. | |
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 | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
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 | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Provide text for the administrative summary | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
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 | 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 | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Validates the handler against the complete View. | |
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_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
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 | 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 | ||
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 | ||
views_object:: |
public | function | Unpacks each handler to store translatable texts. |
views_object:: |
public | function | Unpack a single option definition. |
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. |