class views_plugin_access in Views (for Drupal 7) 7.3
Same name and namespace in other branches
- 6.3 plugins/views_plugin_access.inc \views_plugin_access
- 6.2 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 $view
* The view object.
* @param object $display
* The display handler.
*/
public 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.
*/
public function option_definition() {
return array();
}
/**
* Provide the default form for setting options.
*/
public function options_form(&$form, &$form_state) {
}
/**
* Provide the default form form for validating options.
*/
public function options_validate(&$form, &$form_state) {
}
/**
* Provide the default form form for submitting options.
*/
public function options_submit(&$form, &$form_state) {
}
/**
* Return a string to display as the clickable title for the access control.
*/
public function summary_title() {
return t('Unknown');
}
/**
* Determine if the current user has access or not.
*/
public 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 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.
*/
public function get_access_callback() {
// Default to no access control.
return TRUE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function | ||
views_plugin:: |
public | property | The current used views display. | |
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
views_plugin:: |
public | property |
The top object of a view. Overrides views_object:: |
1 |
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
views_plugin:: |
public | function | Return the human readable name of the display. | |
views_plugin:: |
public | function | Add anything to the query that we might need to. | 7 |
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
views_plugin:: |
public | function | Validate that the plugin is correct and can be saved. | 3 |
views_plugin_access:: |
public | function | Determine if the current user has access or not. | 4 |
views_plugin_access:: |
public | function | Determine the access callback and arguments. | 4 |
views_plugin_access:: |
public | function | Initialize the plugin. | |
views_plugin_access:: |
public | function |
Provide the default form for setting options. Overrides views_plugin:: |
2 |
views_plugin_access:: |
public | function |
Provide the default form form for submitting options. Overrides views_plugin:: |
1 |
views_plugin_access:: |
public | function |
Provide the default form form for validating options. Overrides views_plugin:: |
1 |
views_plugin_access:: |
public | function |
Retrieve the options when this is a new access control plugin. Overrides views_object:: |
4 |
views_plugin_access:: |
public | function |
Return a string to display as the clickable title for the access control. Overrides views_plugin:: |
3 |