class LayoutAccessNegatable

A common base class used for access handlers that may be negated.

Hierarchy

class LayoutHandler
- class LayoutAccess
  - class LayoutAccessNegatable

Expanded class hierarchy of LayoutAccessNegatable

1 string reference to 'LayoutAccessNegatable'

layout_autoload_info in core/modules/layout/layout.module: Implements hook_autoload_info().

File

core/modules/layout/plugins/access/layout_access.inc, line 143: Class for loading, modifying, and saving a layout access rule (condition).

View source

class LayoutAccessNegatable extends LayoutAccess {
  function __construct($plugin_name, array $data = array()) {
    parent::__construct($plugin_name, $data);
    // Ensure a setting always exists for negation.
    $this->settings += array(
      'negate' => FALSE,
    );
  }

  /**
   * {@inheritdoc}
   */
  function form(&$form, &$form_state) {
    parent::form($form, $form_state);
    $form['negate'] = array(
      '#type' => 'checkbox',
      '#title' => t('Reverse (NOT)'),
      '#weight' => 100,
      '#default_value' => $this->settings['negate'],
    );
  }

  /**
   * {@inheritdoc}
   */
  function formSubmit($form, &$form_state) {
    parent::formSubmit($form, $form_state);
    $this->settings['negate'] = !empty($form_state['values']['negate']);
  }
}

Members

Name	Type	Description
LayoutAccess::checkAccess	function	Checks for access based on the available context.
LayoutAccess::formValidate	function	Validate handler for the settings form for this access item.
LayoutAccess::getRequiredContexts	function	Get a list of all context plugin names required for this access check.
LayoutAccess::setContexts	function	Sets the contexts for this item from the full list of layout contexts.
LayoutAccess::summary	function	Provides a human-readable summary of this access check's behavior.
LayoutAccess::toArray	function	Convert this object's properties to an array. Overrides LayoutHandler::toArray
LayoutAccessNegatable::form	function	Settings form for configuring this access item. Overrides LayoutAccess::form
LayoutAccessNegatable::formSubmit	function	Submit handler for the settings form for this access item. Overrides LayoutAccess::formSubmit
LayoutAccessNegatable::__construct	function	Constructor for a Layout access rule. Overrides LayoutAccess::__construct
LayoutHandler::label	function	Assemble a human-readable label of this object.