You are here

class views_plugin_access in Views (for Drupal 7) 6.3

Same name and namespace in other branches
  1. 6.2 plugins/views_plugin_access.inc \views_plugin_access
  2. 7.3 plugins/views_plugin_access.inc \views_plugin_access

The base plugin to handle access control.

Hierarchy

Expanded class hierarchy of views_plugin_access

1 string reference to 'views_plugin_access'
views_views_plugins in includes/plugins.inc
Implementation of hook_views_plugins

File

plugins/views_plugin_access.inc, line 8

View source
class views_plugin_access extends views_plugin {

  /**
   * Initialize the plugin.
   *
   * @param $view
   *   The view object.
   * @param $display
   *   The display handler.
   */
  function init(&$view, &$display) {
    $this->view =& $view;
    $this->display =& $display;
    if (is_object($display->handler)) {
      $options = $display->handler
        ->get_option('access');

      // Overlay incoming options on top of defaults
      $this
        ->unpack_options($this->options, $options);
    }
  }

  /**
   * Retrieve the options when this is a new access
   * control plugin
   */
  function option_definition() {
    return array();
  }

  /**
   * Provide the default form for setting options.
   */
  function options_form(&$form, &$form_state) {
  }

  /**
   * Provide the default form form for validating options
   */
  function options_validate(&$form, &$form_state) {
  }

  /**
   * Provide the default form form for submitting options
   */
  function options_submit($form, &$form_state) {
  }

  /**
   * Return a string to display as the clickable title for the
   * access control.
   */
  function summary_title() {
    return t('Unknown');
  }

  /**
   * Determine if the current user has access or not.
   */
  function access($account) {

    // default to no access control.
    return TRUE;
  }

  /**
   * Determine the access callback and arguments.
   *
   * This information will be embedded in the menu in order to reduce
   * performance hits during menu item access testing, which happens
   * a lot.
   *
   * @return an array; the first item should be the function to call,
   *   and the second item should be an array of arguments. The first
   *   item may also be TRUE (bool only) which will indicate no
   *   access control.)
   */
  function get_access_callback() {

    // default to no access control.
    return TRUE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_object::$definition property Handler's definition
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. 6
views_object::destroy function 2
views_object::export_option function 1
views_object::export_options function
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::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::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function
views_plugin::$display property The current used views display.
views_plugin::$plugin_type property The plugin type of this plugin, for example style or query.
views_plugin::$view property The top object of a view. Overrides views_object::$view 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. 7
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::access function Determine if the current user has access or not. 2
views_plugin_access::get_access_callback function Determine the access callback and arguments. 2
views_plugin_access::init function Initialize the plugin.
views_plugin_access::options_form function Provide the default form for setting options. Overrides views_plugin::options_form 2
views_plugin_access::options_submit function Provide the default form form for submitting options Overrides views_plugin::options_submit 1
views_plugin_access::options_validate function Provide the default form form for validating options Overrides views_plugin::options_validate 1
views_plugin_access::option_definition function Retrieve the options when this is a new access control plugin Overrides views_object::option_definition 2
views_plugin_access::summary_title function Return a string to display as the clickable title for the access control. 3