class views_plugin in Views (for Drupal 7) 6.3
Same name and namespace in other branches
- 6.2 includes/plugins.inc \views_plugin
- 7.3 includes/plugins.inc \views_plugin
Abstract base class to provide interface common to all plugins.
Hierarchy
- class \views_object
- class \views_plugin
Expanded class hierarchy of views_plugin
File
- includes/
plugins.inc, line 463 - plugins.inc Built in plugins for Views output handling.
View source
class views_plugin extends views_object {
/**
* The top object of a view.
*
* @var view
*/
var $view = NULL;
/**
* The current used views display.
*
* @var views_display
*/
var $display = NULL;
/**
* The plugin type of this plugin, for example style or query.
*/
var $plugin_type = NULL;
/**
* Provide a form to edit options for this plugin.
*/
function options_form(&$form, &$form_state) {
}
/**
* Validate the options form.
*/
function options_validate(&$form, &$form_state) {
}
/**
* Handle any special handling on the validate form.
*/
function options_submit($form, &$form_state) {
}
/**
* Add anything to the query that we might need to.
*/
function query() {
}
/**
* Provide a full list of possible theme templates used by this style.
*/
function theme_functions() {
return views_theme_functions($this->definition['theme'], $this->view, $this->display);
}
/**
* Provide a list of additional theme functions for the theme information page
*/
function additional_theme_functions() {
$funcs = array();
if (!empty($this->definition['additional themes'])) {
foreach ($this->definition['additional themes'] as $theme => $type) {
$funcs[] = views_theme_functions($theme, $this->view, $this->display);
}
}
return $funcs;
}
/**
* Validate that the plugin is correct and can be saved.
*
* @return
* An array of error strings to tell the user what is wrong with this
* plugin.
*/
function validate() {
return array();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_object:: |
property | Handler's definition | ||
views_object:: |
property | Except for displays, options for the object will be held here. | 1 | |
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | 6 | |
views_object:: |
function | 2 | ||
views_object:: |
function | 1 | ||
views_object:: |
function | |||
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | 1 | |
views_object:: |
function | Information about options for all kinds of purposes will be held here. | 13 | |
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 | Let the handler know what its full definition is. | ||
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 | Unpack a single option definition. | ||
views_object:: |
function | Unpacks each handler to store translatable texts. | ||
views_object:: |
function | |||
views_plugin:: |
property | The current used views display. | ||
views_plugin:: |
property | The plugin type of this plugin, for example style or query. | ||
views_plugin:: |
property |
The top object of a view. Overrides views_object:: |
1 | |
views_plugin:: |
function | Provide a list of additional theme functions for the theme information page | ||
views_plugin:: |
function | Provide a form to edit options for this plugin. | 13 | |
views_plugin:: |
function | Handle any special handling on the validate form. | 9 | |
views_plugin:: |
function | Validate the options form. | 8 | |
views_plugin:: |
function | Add anything to the query that we might need to. | 7 | |
views_plugin:: |
function | Provide a full list of possible theme templates used by this style. | ||
views_plugin:: |
function | Validate that the plugin is correct and can be saved. | 2 |