abstract class AccessControlKitHandler in Access Control Kit 7

Base class for object access handlers.

Hierarchy

• class \AccessControlKitHandler implements AccessControlKitHandlerInterface

File

./ack_handler.inc, line 189

Contains the access control kit handler interface and base class.

abstract class AccessControlKitHandler implements AccessControlKitHandlerInterface {

  /**
   * The access handler configuration.
   *
   * @var array
   */
  protected $settings;

  /**
   * Implements AccessControlKitHandlerInterface::__construct().
   */
  public function __construct($scheme, array $settings = array()) {
    $this->settings = $settings;
  }

  /**
   * Implements AccessControlKitHandlerInterface::getSettings().
   */
  public function getSettings() {
    return $this->settings;
  }

  /**
   * Implements AccessControlKitHandlerInterface::description().
   */
  public function description() {
    return '';
  }

  /**
   * Implements AccessControlKitHandlerInterface::settingsForm().
   */
  public function settingsForm() {
    return array();
  }

  /**
   * Implements AccessControlKitHandlerInterface::objectRealms().
   */
  public function objectRealms($object_type, $object) {
    return array();
  }

  /**
   * Implements AccessControlKitHandlerInterface::objectFormAlter().
   */
  public function objectFormAlter($object_type, $object, &$form, &$form_state, $form_id, $realms = NULL) {

    // No filtering needed in the abstract class.
  }

  /**
   * Implements AccessControlKitHandlerInterface::objectFormValidate().
   */
  public function objectFormValidate($object_type, $object, $form, &$form_state) {

    // No validation needed in the abstract class.
  }

  /**
   * Implements AccessControlKitHandlerInterface::objectFormSubmit().
   */
  public function objectFormSubmit($object_type, $object, $form, &$form_state) {

    // No submit actions needed in the abstract class.
  }

  /**
   * Implements AccessControlKitHandlerInterface::viewsDataAlter().
   */
  public function viewsDataAlter(&$data, $scheme_machine_name, $realm_field_table_name, $realm_field_table_value, $object_type) {

    // No Views integration needed in the abstract class.
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AccessControlKitHandler::$settings	protected	property	The access handler configuration.
AccessControlKitHandler::description	public	function	Implements AccessControlKitHandlerInterface::description(). Overrides AccessControlKitHandlerInterface::description	6
AccessControlKitHandler::getSettings	public	function	Implements AccessControlKitHandlerInterface::getSettings(). Overrides AccessControlKitHandlerInterface::getSettings
AccessControlKitHandler::objectFormAlter	public	function	Implements AccessControlKitHandlerInterface::objectFormAlter(). Overrides AccessControlKitHandlerInterface::objectFormAlter	3
AccessControlKitHandler::objectFormSubmit	public	function	Implements AccessControlKitHandlerInterface::objectFormSubmit(). Overrides AccessControlKitHandlerInterface::objectFormSubmit	1
AccessControlKitHandler::objectFormValidate	public	function	Implements AccessControlKitHandlerInterface::objectFormValidate(). Overrides AccessControlKitHandlerInterface::objectFormValidate
AccessControlKitHandler::objectRealms	public	function	Implements AccessControlKitHandlerInterface::objectRealms(). Overrides AccessControlKitHandlerInterface::objectRealms	6
AccessControlKitHandler::settingsForm	public	function	Implements AccessControlKitHandlerInterface::settingsForm(). Overrides AccessControlKitHandlerInterface::settingsForm	3
AccessControlKitHandler::viewsDataAlter	public	function	Implements AccessControlKitHandlerInterface::viewsDataAlter(). Overrides AccessControlKitHandlerInterface::viewsDataAlter	1
AccessControlKitHandler::__construct	public	function	Implements AccessControlKitHandlerInterface::__construct(). Overrides AccessControlKitHandlerInterface::__construct	3