class og_subgroups_plugin_argument_default_user_groups in Subgroups for Organic groups 7.2
The class defining the Views plugin loading the groups and subgroups of the acting user.
Hierarchy
- class \views_object
Expanded class hierarchy of og_subgroups_plugin_argument_default_user_groups
1 string reference to 'og_subgroups_plugin_argument_default_user_groups'
- og_subgroups_views_plugins in ./
og_subgroups.views.inc - Implements hook_views_plugins().
File
- plugins/
views/ og_subgroups_plugin_argument_default_user_groups.inc, line 13 - Holds the class defining the Views plugin loading the groups and subgroups the acting user is member of.
View source
class og_subgroups_plugin_argument_default_user_groups extends views_plugin_argument_default {
/**
* List the options relevant for this plugin.
*/
function option_definition() {
$options = parent::option_definition();
$groups = og_get_all_group_entity();
$options['group_type'] = array(
'default' => key($groups),
);
$options['glue'] = array(
'default' => '+',
);
return $options;
}
/**
* Provide the default form for setting options.
*/
function options_form(&$form, &$form_state) {
$form['group_type'] = array(
'#type' => 'select',
'#title' => t('Group type'),
'#description' => t('Select the group type.'),
'#options' => og_get_all_group_entity(),
'#default_value' => $this->options['group_type'],
'#required' => og_get_all_group_entity(),
);
$form['glue'] = array(
'#type' => 'select',
'#title' => t('Concatenator'),
'#description' => t('Select the concatenator used to merge multiple group IDs. Remember to turn on the "Allow multiple values" option in the "more" settings for this contextual filter.'),
'#options' => array(
'+' => '+',
',' => ',',
),
'#default_value' => $this->options['glue'],
);
}
/**
* Get the default argument.
*/
function get_argument() {
global $user;
// Get the group and subgroups IDs relevant for the acting user,
// and return them concatenated.
$gids = og_get_groups_by_user(NULL, $this->options['group_type']);
$sub_gids = og_subgroup_user_groups_load($user);
if (is_array($gids) || isset($sub_gids['node'])) {
$total_gids = !empty($sub_gids['node']) ? $gids + $sub_gids['node'] : $gids;
if (!empty($total_gids)) {
return implode($this->options['glue'], $total_gids);
}
}
return FALSE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
og_subgroups_plugin_argument_default_user_groups:: |
function |
Get the default argument. Overrides views_plugin_argument_default:: |
||
og_subgroups_plugin_argument_default_user_groups:: |
function |
Provide the default form for setting options. Overrides views_plugin_argument_default:: |
||
og_subgroups_plugin_argument_default_user_groups:: |
function |
List the options relevant for this plugin. Overrides views_plugin_argument_default:: |
||
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 | Returns the summary of the settings in the display. | 8 |
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_argument_default:: |
public | function | Determine if the administrator has the privileges to use this plugin. | 1 |
views_plugin_argument_default:: |
public | function | If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input. | |
views_plugin_argument_default:: |
public | function | Convert options from the older style. | 3 |
views_plugin_argument_default:: |
public | function | Initialize this plugin with the view and the argument it is linked to. | 1 |
views_plugin_argument_default:: |
public | function |
Provide the default form form for submitting options. Overrides views_plugin:: |
1 |
views_plugin_argument_default:: |
public | function |
Provide the default form form for validating options. Overrides views_plugin:: |