class simple_access_views_plugin_group in Simple Access 7.2

@file Views access plugin to make use of cimple access.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_access
      • class \simple_access_views_plugin_group

3 string references to 'simple_access_views_plugin_group'

simple_access_views_plugins in ./simple_access.views.inc

Implements hook_views_plugins().

simple_access_views_plugin_group::options_form in views/simple_access_views_plugin_group.inc

Provide the default form for setting options.

simple_access_views_plugin_group::summary_title in views/simple_access_views_plugin_group.inc

Return a string to display as the clickable title for the access control.

File

views/simple_access_views_plugin_group.inc, line 7

Views access plugin to make use of cimple access.

class simple_access_views_plugin_group extends views_plugin_access {

  /**
   * {@inheritdoc}
   */
  public function access($account) {
    $roles = array_keys($account->roles);
    $roles[] = $account->uid ? DRUPAL_AUTHENTICATED_RID : DRUPAL_ANONYMOUS_RID;
    $groups = simple_access_groups_from_roles($roles);
    return array_intersect(array_filter($this->options['groups']), $groups);
  }

  /**
   * {@inheritdoc}
   */
  public function get_access_callback() {
    return array(
      'simple_access_groups_check_user',
      array(
        array_filter($this->options['groups']),
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function summary_title() {
    $count = count($this->options['groups']);
    if ($count < 1) {
      return t('No group(s) selected');
    }
    elseif ($count > 1) {
      return t('Multiple groups');
    }
    else {
      $gids = array_map(array(
        'simple_access_views_plugin_group',
        '_map_groups',
      ), simple_access_get_groups());
      $gid = array_shift($this->options['groups']);
      return $gids[$gid];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function option_defaults(&$options) {
    $options['groups'] = array();
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $options = array_map(array(
      'simple_access_views_plugin_group',
      '_map_groups',
    ), simple_access_get_groups());
    $form['groups'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Simple access groups'),
      '#default_value' => $this->options['groups'],
      '#options' => $options,
      '#description' => t('Only the checked simple access groups will be able to access this display. Note that users with "access all views" can see any view, regardless of role.'),
    );
  }

  /**
   * Callback for array_map.
   */
  public function _map_groups($a) {
    return $a['name'];
  }

  /**
   * Validate the options form.
   */
  public function options_validate(&$form, &$form_state) {
    if (!array_filter($form_state['values']['access_options']['groups'])) {
      form_error($form['role'], t('You must select at least one group if type is "by group"'));
    }
  }

  /**
   * Submit the options form.
   */
  public function options_submit(&$form, &$form_state) {

    // I hate checkboxes.
    $form_state['values']['access_options']['groups'] = array_filter($form_state['values']['access_options']['groups']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
simple_access_views_plugin_group::access	public	function	Determine if the current user has access or not. Overrides views_plugin_access::access
simple_access_views_plugin_group::get_access_callback	public	function	Determine the access callback and arguments. Overrides views_plugin_access::get_access_callback
simple_access_views_plugin_group::options_form	public	function	Provide the default form for setting options. Overrides views_plugin_access::options_form
simple_access_views_plugin_group::options_submit	public	function	Submit the options form. Overrides views_plugin_access::options_submit
simple_access_views_plugin_group::options_validate	public	function	Validate the options form. Overrides views_plugin_access::options_validate
simple_access_views_plugin_group::option_defaults	public	function
simple_access_views_plugin_group::summary_title	public	function	Return a string to display as the clickable title for the access control. Overrides views_plugin_access::summary_title
simple_access_views_plugin_group::_map_groups	public	function	Callback for array_map.
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::option_definition	public	function	Retrieve the options when this is a new access control plugin. Overrides views_object::option_definition	4