class og_context_plugin_access_og_perm in Organic groups 7.2

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 \og_context_plugin_access_og_perm

1 string reference to 'og_context_plugin_access_og_perm'

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_access_og_perm.inc, line 12

Contains views access plugin for OG permissions

class og_context_plugin_access_og_perm extends views_plugin_access {

  /**
   * Retrieve the options when this is a new access
   * control plugin
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['perm'] = array(
      'default' => 'edit group',
    );
    $options['group_type'] = array(
      'default' => 'node',
    );
    $options['group_id_arg'] = array(
      'default' => FALSE,
    );
    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.'),
    );
    $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.'),
    );
    $current_display = $this->view->current_display;
    if ($this->view->display[$current_display]->handler
      ->has_path()) {

      // Show the group ID argument position only for "Page" displays.
      $form['group_id_arg'] = array(
        '#type' => 'select',
        '#title' => t('Argument position for group ID'),
        '#default_value' => $this->options['group_id_arg'],
        '#options' => array(
          NULL => t('None'),
        ) + range(0, 9),
        '#description' => t('Group ID argument position with arg() function. e.g. if your dynamic path is "node/%/group/%/overview" and you are using the second "%" for group IDs you have to choose "3" like "arg(3)".'),
      );
    }
  }

  /**
   * Return a string to display as the clickable title for the
   * access control.
   */
  function summary_title() {
    $current_display = $this->view->current_display;
    if ($this->options['group_id_arg'] === FALSE || $this->view->display[$current_display]->display_plugin != 'page') {
      return $this->options['perm'];
    }
    $params = array(
      '@perm' => $this->options['perm'],
      '@arg' => $this->options['group_id_arg'],
    );
    return t('@perm, getting the group ID from argument position @arg', $params);
  }

  /**
   * 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
    if ($group = og_context($this->options['group_type'])) {
      return og_user_access($group['group_type'], $group['gid'], $this->options['perm'], $account);
    }
    return FALSE;
  }

  /**
   * Determine the access callback and arguments.
   */
  function get_access_callback() {
    return array(
      '_og_context_views_page_access',
      array(
        $this->options['group_type'],
        $this->options['perm'],
        $this->options['group_id_arg'],
      ),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
og_context_plugin_access_og_perm::access		function	Determine if the current user has access or not. Overrides views_plugin_access::access
og_context_plugin_access_og_perm::get_access_callback		function	Determine the access callback and arguments. Overrides views_plugin_access::get_access_callback
og_context_plugin_access_og_perm::options_form		function	Provide the default form for setting options. Overrides views_plugin_access::options_form
og_context_plugin_access_og_perm::option_definition		function	Retrieve the options when this is a new access control plugin Overrides views_plugin_access::option_definition
og_context_plugin_access_og_perm::summary_title		function	Return a string to display as the clickable title for the access control. Overrides views_plugin_access::summary_title
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::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_access::init	public	function	Initialize the plugin.
views_plugin_access::options_submit	public	function	Provide the default form form for submitting options. Overrides views_plugin::options_submit	1
views_plugin_access::options_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate	1