class signup_plugin_access_user_signup_list in Signup 7

Validate whether an argument is a user who has permission to view signups.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_access
      • class \signup_plugin_access_user_signup_list

1 string reference to 'signup_plugin_access_user_signup_list'

signup_views_plugins in views/signup.views.inc

Implements hook_views_plugins().

File

views/plugins/signup_plugin_access_user_signup_list.inc, line 5

class signup_plugin_access_user_signup_list extends views_plugin_access {

  /**
   * See if the given user should have access outside of the menu system.
   *
   * This is used for block displays, for example. If the given account has
   * the 'view all signups' permission, we always grant access.  Otherwise, we
   * only grant access if the user the view is listing (from a given argument)
   * matches the given account.
   */
  function access($account) {
    if (user_access('view all signups', $account)) {
      return TRUE;
    }
    $this->view
      ->set_display($this->display->id);
    $this->view
      ->init_handlers();
    $user_arg = $this->options['signup_user_argument'];
    $argument = $this->view->argument[$user_arg];
    return $account->uid == $argument
      ->get_value();
  }
  function get_access_callback() {
    return array(
      'signup_view_user_list_access',
      array(
        $this->view->name,
        $this->display->id,
        $this->options['signup_user_argument'],
      ),
    );
  }
  function summary_title() {
    return t('View signup user list');
  }
  function option_defaults(&$options) {
    $options['signup_user_argument'] = '';
  }
  function options_form(&$form, &$form_state) {
    $arguments = array();
    foreach ($this->view->display_handler
      ->get_handlers('argument') as $id => $handler) {
      $arguments[$id] = $handler->definition['title'];
    }
    $form['signup_user_argument'] = array(
      '#type' => 'select',
      '#options' => $arguments,
      '#title' => t('Signup user argument'),
      '#description' => t('You must select which argument to this view represents the user who signed up.'),
      '#default_value' => $this->options['signup_user_argument'],
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
signup_plugin_access_user_signup_list::access		function	See if the given user should have access outside of the menu system. Overrides views_plugin_access::access
signup_plugin_access_user_signup_list::get_access_callback		function	Determine the access callback and arguments. Overrides views_plugin_access::get_access_callback
signup_plugin_access_user_signup_list::options_form		function	Provide the default form for setting options. Overrides views_plugin_access::options_form
signup_plugin_access_user_signup_list::option_defaults		function
signup_plugin_access_user_signup_list::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
views_plugin_access::option_definition	public	function	Retrieve the options when this is a new access control plugin. Overrides views_object::option_definition	4