You are here

Home » API reference » Views (for Drupal 7) 8.3 » Permission.php

class Permission in Views (for Drupal 7) 8.3

Access plugin that provides permission-based access control.

Plugin annotation


@Plugin(
  id = "perm",
  title = @Translation("Permission"),
  help = @Translation("Access will be granted to users with the specified permission string.")
)

Hierarchy

Expanded class hierarchy of Permission

Related topics

Views access plugins
The base plugin to handle access to a view.
2 string references to 'Permission'
Permission::buildOptionsForm in lib/Views/user/Plugin/views/access/Permission.php
Provide the default form for setting options.
user_views_data in modules/user.views.inc
Implements hook_views_data().

File

lib/Views/user/Plugin/views/access/Permission.php, line 25
Definition of Views\user\Plugin\views\access\Permission.

Namespace

Views\user\Plugin\views\access
View source 
class Permission extends AccessPluginBase {

  /**
   * Overrides Drupal\views\Plugin\Plugin::$usesOptions.
   */
  protected $usesOptions = TRUE;
  public function access($account) {
    return views_check_perm($this->options['perm'], $account);
  }
  function get_access_callback() {
    return array(
      'views_check_perm',
      array(
        $this->options['perm'],
      ),
    );
  }
  public function summaryTitle() {
    $permissions = module_invoke_all('permission');
    if (isset($permissions[$this->options['perm']])) {
      return $permissions[$this->options['perm']]['title'];
    }
    return t($this->options['perm']);
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['perm'] = array(
      'default' => 'access content',
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $perms = array();
    $module_info = system_get_info('module');

    // Get list of permissions
    foreach (module_implements('permission') as $module) {
      $permissions = module_invoke($module, 'permission');
      foreach ($permissions as $name => $perm) {
        $perms[$module_info[$module]['name']][$name] = strip_tags($perm['title']);
      }
    }
    ksort($perms);
    $form['perm'] = array(
      '#type' => 'select',
      '#options' => $perms,
      '#title' => t('Permission'),
      '#default_value' => $this->options['perm'],
      '#description' => t('Only users with the selected permission flag will be able to access this display. Note that users with "access all views" can see any view, regardless of other permissions.'),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AccessPluginBase::init public function Initialize the plugin.
AccessPluginBase::submitOptionsForm public function Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm 1
AccessPluginBase::validateOptionsForm public function Provide the default form form for validating options Overrides PluginBase::validateOptionsForm 1
Permission::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
Permission::access public function Determine if the current user has access or not. Overrides AccessPluginBase::access
Permission::buildOptionsForm public function Provide the default form for setting options. Overrides AccessPluginBase::buildOptionsForm
Permission::defineOptions protected function Retrieve the options when this is a new access control plugin Overrides AccessPluginBase::defineOptions
Permission::get_access_callback function Determine the access callback and arguments. Overrides AccessPluginBase::get_access_callback
Permission::summaryTitle public function Return a string to display as the clickable title for the access control. Overrides AccessPluginBase::summaryTitle
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::query public function Add anything to the query that we might need to. 13
PluginBase::setOptionDefaults protected function
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2