class domain_views_plugin_access in Domain Views 7

@file Domain Views plugin that restricts View display based on the current domain. This plugin respects hook_domaingrants().

Access plugin that provides permission-based access control.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_access
      • class \domain_views_plugin_access

1 string reference to 'domain_views_plugin_access'

domain_views_views_plugins in ./domain_views.views.inc

Implements hook_views_plugins().

File

includes/domain_views_plugin_access.inc, line 12

Domain Views plugin that restricts View display based on the current domain. This plugin respects hook_domaingrants().

class domain_views_plugin_access extends views_plugin_access {
  function access($account) {
    return domain_views_access(array_filter($this->options['domains']), $this->options['domain_strict'], $this->options['domain_member']);
  }
  function get_access_callback() {
    return array(
      'domain_views_access',
      array(
        array_filter($this->options['domains']),
        $this->options['domain_strict'],
        $this->options['domain_member'],
      ),
    );
  }
  function summary_title() {
    return t('Domains');
  }
  function option_definition() {
    $options = parent::option_definition();

    // Handle 7.x.2 and 7.x.3.
    $default = domain_default_id();
    if ($default == 0) {
      $default = -1;
    }
    $options['domains'] = array(
      'default' => array(
        $default => $default,
      ),
    );
    $options['domain_strict'] = array(
      'default' => FALSE,
    );
    $options['domain_member'] = array(
      'default' => FALSE,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    $domains = domain_domains();
    $options = array();
    $format = domain_select_format();
    foreach ($domains as $domain) {

      // Checkboxes cannot handles zeros.
      if ($domain['domain_id'] == 0) {
        $domain['domain_id'] = -1;
      }

      // The domain must be valid.
      if ($domain['valid'] || user_access('access inactive domains')) {

        // Filter checkboxes but not select lists.
        $options[$domain['domain_id']] = empty($format) ? check_plain($domain['sitename']) : $domain['sitename'];
      }
    }
    $form['domains'] = array(
      '#type' => empty($format) ? 'checkboxes' : 'select',
      '#multiple' => TRUE,
      '#options' => $options,
      '#title' => t('Domains'),
      '#default_value' => $this->options['domains'],
      '#description' => t('This display will only be available on the selected domains. Note that users with "access all views" can see any view, regardless of other permissions.'),
    );
    if ($format) {
      $form['domains']['#multiple'] = TRUE;
      $form['domains']['#size'] = count($options) > 10 ? 10 : count($options);
    }
    $form['domain_strict'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use strict access control'),
      '#default_value' => $this->options['domain_strict'],
      '#description' => t('If checked, the user must be able to access the domain being viewed.'),
    );
    $form['domain_member'] = array(
      '#type' => 'checkbox',
      '#title' => t('Require domain membership'),
      '#default_value' => $this->options['domain_member'],
      '#description' => t('If checked, the user must be a member of the domain being viewed.'),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
domain_views_plugin_access::access		function	Determine if the current user has access or not. Overrides views_plugin_access::access
domain_views_plugin_access::get_access_callback		function	Determine the access callback and arguments. Overrides views_plugin_access::get_access_callback
domain_views_plugin_access::options_form		function	Provide the default form for setting options. Overrides views_plugin_access::options_form
domain_views_plugin_access::option_definition		function	Retrieve the options when this is a new access control plugin. Overrides views_plugin_access::option_definition
domain_views_plugin_access::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