class views_plugin_access_role

Access plugin that provides role-based access control.

Hierarchy

Expanded class hierarchy of views_plugin_access_role

Related topics

Views access plugins
@todo .
1 string reference to 'views_plugin_access_role'
views_views_plugins in includes/plugins.inc
Implements hook_views_plugins().

File

plugins/views_plugin_access_role.inc, line 13

View source 
class views_plugin_access_role extends views_plugin_access {
    
    /**
     * {@inheritdoc}
     */
    public function access($account) {
        return views_check_roles(array_filter($this->options['role']), $account);
    }
    
    /**
     * {@inheritdoc}
     */
    public function get_access_callback() {
        return array(
            'views_check_roles',
            array(
                array_filter($this->options['role']),
            ),
        );
    }
    
    /**
     * {@inheritdoc}
     */
    public function summary_title() {
        $count = count($this->options['role']);
        if ($count < 1) {
            return t('No role(s) selected');
        }
        elseif ($count > 1) {
            return t('Multiple roles');
        }
        else {
            $rids = views_ui_get_roles();
            $rid = reset($this->options['role']);
            return check_plain($rids[$rid]);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['role'] = array(
            'default' => array(),
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $form['role'] = array(
            '#type' => 'checkboxes',
            '#title' => t('Role'),
            '#default_value' => $this->options['role'],
            '#options' => array_map('check_plain', 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.'),
        );
    }
    
    /**
     * {@inheritdoc}
     */
    public 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"'));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_submit(&$form, &$form_state) {
        // I hate checkboxes.
        $form_state['values']['access_options']['role'] = array_filter($form_state['values']['access_options']['role']);
    }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
views_object::$definition public property Handler&#039;s definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition public function Collect this handler&#039;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&#039;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_role::access public function Determine if the current user has access or not. Overrides views_plugin_access::access
views_plugin_access_role::get_access_callback public function Determine the access callback and arguments. Overrides views_plugin_access::get_access_callback
views_plugin_access_role::options_form public function Provide the default form for setting options. Overrides views_plugin_access::options_form
views_plugin_access_role::options_submit public function Provide the default form form for submitting options. Overrides views_plugin_access::options_submit
views_plugin_access_role::options_validate public function Provide the default form form for validating options. Overrides views_plugin_access::options_validate
views_plugin_access_role::option_definition public function Retrieve the options when this is a new access control plugin. Overrides views_plugin_access::option_definition
views_plugin_access_role::summary_title public function Return a string to display as the clickable title for the access control. Overrides views_plugin_access::summary_title