class og_context_plugin_argument_default_group_context in Organic groups 7.2

The group context argument default handler.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_argument_default
      • class \og_context_plugin_argument_default_group_context

1 string reference to 'og_context_plugin_argument_default_group_context'

og_context_views_plugins in og_context/includes/views/og_context.views.inc

Implements hook_views_plugins().

File

og_context/includes/views/handlers/og_context_plugin_argument_default_group_context.inc, line 11

Contains the group context argument default plugin.

class og_context_plugin_argument_default_group_context extends views_plugin_argument_default {

  /**
   * Retrieve the options when this is a new access
   * control plugin
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['group_type'] = array(
      'default' => 'node',
    );
    $options['check_access'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    return $options;
  }

  /**
   * Provide the default form for setting options.
   */
  function options_form(&$form, &$form_state) {
    $form['group_type'] = array(
      '#type' => 'select',
      '#options' => og_get_all_group_entity(),
      '#title' => t('Group type'),
      '#default_value' => $this->options['group_type'],
      '#description' => t('Determine what entity type that group should be of.'),
    );
    $form['check_access'] = array(
      '#type' => 'checkbox',
      '#title' => t('Check access'),
      '#description' => t('Determines if access to the group should be done. Defaults to "Checked".'),
      '#default_value' => $this->options['check_access'],
    );
  }

  /**
   * Return the group context argument.
   */
  function get_argument() {
    if ($group = og_context($this->options['group_type'], NULL, NULL, $this->options['check_access'])) {
      return $group['gid'];
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
og_context_plugin_argument_default_group_context::get_argument		function	Return the group context argument. Overrides views_plugin_argument_default::get_argument
og_context_plugin_argument_default_group_context::options_form		function	Provide the default form for setting options. Overrides views_plugin_argument_default::options_form
og_context_plugin_argument_default_group_context::option_definition		function	Retrieve the options when this is a new access control plugin Overrides views_plugin_argument_default::option_definition
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::query	public	function	Add anything to the query that we might need to.	7
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_argument_default::access	public	function	Determine if the administrator has the privileges to use this plugin.	1
views_plugin_argument_default::check_access	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::convert_options	public	function	Convert options from the older style.	3
views_plugin_argument_default::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
views_plugin_argument_default::options_submit	public	function	Provide the default form form for submitting options. Overrides views_plugin::options_submit	1
views_plugin_argument_default::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate