class views_plugin_access_role in Views (for Drupal 7) 6.2

Access plugin that provides role-based access control.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_access
      • class \views_plugin_access_role

1 string reference to 'views_plugin_access_role'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_access_role.inc, line 6

class views_plugin_access_role extends views_plugin_access {
  function access($account) {
    return views_check_roles(array_filter($this->options['role']), $account);
  }
  function get_access_callback() {
    return array(
      'views_check_roles',
      array(
        array_filter($this->options['role']),
      ),
    );
  }
  function summary_title() {
    $count = count($this->options['role']);
    if ($count < 1) {
      return t('No role(s) selected');
    }
    else {
      if ($count > 1) {
        return t('Multiple roles');
      }
      else {
        $rids = views_ui_get_roles();
        $rid = reset($this->options['role']);
        return $rids[$rid];
      }
    }
  }
  function option_defaults(&$options) {
    $options['role'] = array();
  }
  function options_form(&$form, &$form_state) {
    $form['role'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Role'),
      '#default_value' => $this->options['role'],
      '#options' => views_ui_get_roles(),
      '#description' => t('Only the checked roles will be able to access this display. Note that users with "access all views" can see any view, regardless of role.'),
    );
  }
  function options_validate(&$form, &$form_state) {
    if (!array_filter($form_state['values']['access_options']['role'])) {
      form_error($form['role'], t('You must select at least one role if type is "by role"'));
    }
  }
  function options_submit(&$form, &$form_state) {

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

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$options		property	Except for displays, options for the object will be held here.	1
views_object::construct		function	Views handlers use a special construct function so that we can more easily construct them with variable arguments.	5
views_object::destroy		function		2
views_object::options		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.	1
views_object::option_definition		function	Information about options for all kinds of purposes will be held here.	9
views_object::set_default_options		function	Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition		function	Let the handler know what its full definition is.
views_object::unpack_options		function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults		function		1
views_plugin::additional_theme_functions		function	Provide a list of additional theme functions for the theme information page
views_plugin::query		function	Add anything to the query that we might need to.	3
views_plugin::theme_functions		function	Provide a full list of possible theme templates used by this style.
views_plugin::validate		function	Validate that the plugin is correct and can be saved.	2
views_plugin_access::init		function	Initialize the plugin. Overrides views_plugin::init
views_plugin_access_role::access		function	Determine if the current user has access or not. Overrides views_plugin_access::access
views_plugin_access_role::get_access_callback		function	Determine the access callback and arguments. Overrides views_plugin_access::get_access_callback
views_plugin_access_role::options_form		function	Provide the default form for setting options. Overrides views_plugin_access::options_form
views_plugin_access_role::options_submit		function	Provide the default form form for submitting options Overrides views_plugin_access::options_submit
views_plugin_access_role::options_validate		function	Provide the default form form for validating options Overrides views_plugin_access::options_validate
views_plugin_access_role::option_defaults		function	Retrieve the default options when this is a new access control plugin Overrides views_plugin_access::option_defaults
views_plugin_access_role::summary_title		function	Return a string to display as the clickable title for the access control. Overrides views_plugin_access::summary_title