class views_php_plugin_access in Views PHP 7

Access plugin that provides access control based on custom PHP code.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_access
      • class \views_php_plugin_access

1 string reference to 'views_php_plugin_access'

views_php_views_plugins in ./views_php.views.inc

Implements hook_views_plugins().

File

plugins/views/views_php_plugin_access.inc, line 8

class views_php_plugin_access extends views_plugin_access {

  /**
   * Implements views_plugin_access#summary_title().
   */
  public function summary_title() {
    return t('PHP');
  }

  /**
   * Implements views_object#option_definition().
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['php_access'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Implements views_plugin#options_form().
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form += views_php_form_element($this, FALSE, array(
      'php_access',
      t('Access code'),
      t('If the code returns TRUE the requesting user is granted access to the view.'),
      FALSE,
    ), array(
      '$view_name' => t('The name of the view to check.'),
      '$display_id' => t('The ID of the display to check.'),
      '$account' => t('The account to check.'),
    ));
  }

  /**
   * Implements views_plugin#options_submit().
   */
  public function options_submit(&$form, &$form_state) {
    $form_state['values']['access_options']['php_access'] = $form_state['values']['options']['php_access'];
  }

  /**
   * Implements views_plugin_access#access().
   */
  public function access($account) {
    if (!empty($this->options['php_access'])) {
      return views_php_check_access($this->options['php_access'], $this->view->name, $this->display->id, $account);
    }
    return TRUE;
  }

  /**
   * Implements views_plugin_access#get_access_callback().
   */
  public function get_access_callback() {
    if (!empty($this->options['php_access'])) {
      return array(
        'views_php_check_access',
        array(
          $this->options['php_access'],
          $this->view->name,
          $this->display->id,
        ),
      );
    }
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	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		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_php_plugin_access::access	public	function	Implements views_plugin_access#access(). Overrides views_plugin_access::access
views_php_plugin_access::get_access_callback	public	function	Implements views_plugin_access#get_access_callback(). Overrides views_plugin_access::get_access_callback
views_php_plugin_access::options_form	public	function	Implements views_plugin#options_form(). Overrides views_plugin_access::options_form
views_php_plugin_access::options_submit	public	function	Implements views_plugin#options_submit(). Overrides views_plugin_access::options_submit
views_php_plugin_access::option_definition	public	function	Implements views_object#option_definition(). Overrides views_plugin_access::option_definition
views_php_plugin_access::summary_title	public	function	Implements views_plugin_access#summary_title(). Overrides views_plugin_access::summary_title
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_validate	public	function	Provide the default form form for validating options. Overrides views_plugin::options_validate	1