class views_plugin_access_role
- 3.x plugins/views_plugin_access_role.inc views_plugin_access_role
- 2.x plugins/views_plugin_access_role.inc views_plugin_access_role
Access plugin that provides role-based access control.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_access
- class \views_plugin_access_role
- class \views_plugin_access
- class \views_plugin
Expanded class hierarchy of views_plugin_access_role
1 string reference to 'views_plugin_access_role'
- views_views_plugins in includes/
plugins.inc - Implementation of hook_views_plugins
File
- plugins/
views_plugin_access_role.inc, line 6
View source
class views_plugin_access_role extends views_plugin_access {
function access($account) {
return views_check_roles(array_filter($this->options['role']), $account);
}
function get_access_callback() {
return array('views_check_roles', array(array_filter($this->options['role'])));
}
function summary_title() {
$count = count($this->options['role']);
if ($count < 1) {
return t('No role(s) selected');
}
else if ($count > 1) {
return t('Multiple roles');
}
else {
$rids = views_ui_get_roles();
$rid = reset($this->options['role']);
return $rids[$rid];
}
}
function option_defaults(&$options) {
$options['role'] = array();
}
function options_form(&$form, &$form_state) {
$form['role'] = array(
'#type' => 'checkboxes',
'#title' => t('Role'),
'#default_value' => $this->options['role'],
'#options' => views_ui_get_roles(),
'#description' => t('Only the checked roles will be able to access this display. Note that users with "access all views" can see any view, regardless of role.'),
);
}
function options_validate(&$form, &$form_state) {
if (!array_filter($form_state['values']['access_options']['role'])) {
form_error($form['role'], t('You must select at least one role if type is "by role"'));
}
}
function options_submit(&$form, &$form_state) {
// I hate checkboxes.
$form_state['values']['access_options']['role'] = array_filter($form_state['values']['access_options']['role']);
}
}
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 | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
function | Information about options for all kinds of purposes will be held here. | |
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 | ||
views_plugin:: |
function | Provide a list of additional theme functions for the theme information page | |
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 |
Initialize the plugin. Overrides views_plugin:: |
|
views_plugin_access_role:: |
function |
Determine if the current user has access or not. Overrides views_plugin_access:: |
|
views_plugin_access_role:: |
function |
Determine the access callback and arguments. Overrides views_plugin_access:: |
|
views_plugin_access_role:: |
function |
Provide the default form for setting options. Overrides views_plugin_access:: |
|
views_plugin_access_role:: |
function |
Provide the default form form for submitting options Overrides views_plugin_access:: |
|
views_plugin_access_role:: |
function |
Provide the default form form for validating options Overrides views_plugin_access:: |
|
views_plugin_access_role:: |
function |
Retrieve the default options when this is a new access
control plugin Overrides views_plugin_access:: |
|
views_plugin_access_role:: |
function |
Return a string to display as the clickable title for the
access control. Overrides views_plugin_access:: |