class views_plugin_access

The base plugin to handle access control.

Hierarchy

Expanded class hierarchy of views_plugin_access

Related topics

File

plugins/views_plugin_access.inc, line 19

View source
class views_plugin_access extends views_plugin {
    
    /**
     * Initialize the plugin.
     *
     * @param view $view
     *   The view object.
     * @param object $display
     *   The display handler.
     */
    public 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.
     */
    public function option_definition() {
        return array();
    }
    
    /**
     * Provide the default form for setting options.
     */
    public function options_form(&$form, &$form_state) {
    }
    
    /**
     * Provide the default form form for validating options.
     */
    public function options_validate(&$form, &$form_state) {
    }
    
    /**
     * Provide the default form form for submitting options.
     */
    public function options_submit(&$form, &$form_state) {
    }
    
    /**
     * Return a string to display as the clickable title for the access control.
     */
    public function summary_title() {
        return t('Unknown');
    }
    
    /**
     * Determine if the current user has access or not.
     */
    public 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 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.
     */
    public function get_access_callback() {
        // Default to no access control.
        return TRUE;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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 public 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::access public function Determine if the current user has access or not. 4
views_plugin_access::get_access_callback public function Determine the access callback and arguments. 4
views_plugin_access::init public function Initialize the plugin.
views_plugin_access::options_form public function Provide the default form for setting options. Overrides views_plugin::options_form 2
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
views_plugin_access::summary_title public function Return a string to display as the clickable title for the access control. Overrides views_plugin::summary_title 3