class og_context_plugin_access_og_perm in Organic groups 7
Same name and namespace in other branches
- 7.2 og_context/includes/views/handlers/og_context_plugin_access_og_perm.inc \og_context_plugin_access_og_perm
Allow views to allow access to only users with a specified permission in the current group.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_access
- class \views_plugin
Expanded class hierarchy of og_context_plugin_access_og_perm
1 string reference to 'og_context_plugin_access_og_perm'
- og_context_views_plugins in og_context/
includes/ og_context.views.inc - Implements hook_views_plugins().
File
- og_context/
includes/ views/ og_context_plugin_access_og_perm.inc, line 12 - Contains views access plugin for OG permissions
View source
class og_context_plugin_access_og_perm extends views_plugin_access {
/**
* Determine if the current user has access or not.
*/
function access($account) {
// Attempt to get the group from the current context and determine if the
// user has the appropriate permission within the group
$group = og_context();
if (!$group) {
// We should not allow access to the view if we were unable to find a
// group
return FALSE;
}
return og_user_access($group->gid, $this->options['perm'], $account);
}
/**
* Return a string to display as the clickable title for the
* access control.
*/
function summary_title() {
return $this->options['perm'];
}
/**
* Retrieve the options when this is a new access
* control plugin
*/
function option_definition() {
$options = parent::option_definition();
$options['perm'] = array(
'default' => 'edit group',
);
return $options;
}
/**
* Provide the default form for setting options.
*/
function options_form(&$form, &$form_state) {
$perms = array();
// Get list of permissions
$module_info = system_get_info('module');
foreach (og_get_permissions() as $perm => $info) {
$module_name = $module_info[$info['module']]['name'];
$perms[$module_name][$perm] = strip_tags($info['title']);
}
$form['perm'] = array(
'#type' => 'select',
'#options' => $perms,
'#title' => t('OG permission'),
'#default_value' => $this->options['perm'],
'#description' => t('Only users with the selected permission flag in a group retrieved from context will be able to access this display.'),
);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
og_context_plugin_access_og_perm:: |
function |
Determine if the current user has access or not. Overrides views_plugin_access:: |
||
og_context_plugin_access_og_perm:: |
function |
Provide the default form for setting options. Overrides views_plugin_access:: |
||
og_context_plugin_access_og_perm:: |
function |
Retrieve the options when this is a new access
control plugin Overrides views_plugin_access:: |
||
og_context_plugin_access_og_perm:: |
function |
Return a string to display as the clickable title for the
access control. Overrides views_plugin_access:: |
||
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 the access callback and arguments. | 4 |
views_plugin_access:: |
public | function | Initialize the plugin. | |
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 |