class views_plugin_access
- 3.x plugins/views_plugin_access.inc views_plugin_access
- 2.x plugins/views_plugin_access.inc views_plugin_access
The base plugin to handle access control.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_access
- class \views_plugin
Expanded class hierarchy of views_plugin_access
Related topics
File
- plugins/
views_plugin_access.inc, line 19 - Definition of views_plugin_access.
View source
class views_plugin_access extends views_plugin {
/**
* Initialize the plugin.
*
* @param $view
* The view object.
* @param $display
* The display handler.
*/
function init(&$view, &$display) {
$this->view = &$view;
$this->display = &$display;
if (is_object($display->handler)) {
$options = $display->handler->get_option('access');
// Overlay incoming options on top of defaults
$this->unpack_options($this->options, $options);
}
}
/**
* Retrieve the options when this is a new access
* control plugin
*/
function option_definition() {
return array();
}
/**
* Provide the default form for setting options.
*/
function options_form(&$form, &$form_state) {
}
/**
* Provide the default form form for validating options
*/
function options_validate(&$form, &$form_state) {
}
/**
* Provide the default form form for submitting options
*/
function options_submit(&$form, &$form_state) {
}
/**
* Return a string to display as the clickable title for the
* access control.
*/
function summary_title() {
return t('Unknown');
}
/**
* Determine if the current user has access or not.
*/
function access($account) {
// default to no access control.
return TRUE;
}
/**
* Determine the access callback and arguments.
*
* This information will be embedded in the menu in order to reduce
* performance hits during menu item access testing, which happens
* a lot.
*
* @return an array; the first item should be the function to call,
* and the second item should be an array of arguments. The first
* item may also be TRUE (bool only) which will indicate no
* access control.)
*/
function get_access_callback() {
// default to no access control.
return TRUE;
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
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 | 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:: |
function | Provide a list of additional theme functions for the theme information page | |
views_plugin:: |
function | Return the human readable name of the display. | |
views_plugin:: |
function | Add anything to the query that we might need to. | |
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. | |
views_plugin_access:: |
function | Determine if the current user has access or not. | |
views_plugin_access:: |
function | Determine the access callback and arguments. | |
views_plugin_access:: |
function | Initialize the plugin. | |
views_plugin_access:: |
function |
Provide the default form for setting options. Overrides views_plugin:: |
|
views_plugin_access:: |
function |
Provide the default form form for submitting options Overrides views_plugin:: |
|
views_plugin_access:: |
function |
Provide the default form form for validating options Overrides views_plugin:: |
|
views_plugin_access:: |
function |
Retrieve the options when this is a new access
control plugin Overrides views_object:: |
|
views_plugin_access:: |
function |
Return a string to display as the clickable title for the
access control. Overrides views_plugin:: |