interface VariableRealmControllerInterface in Variable 7.2

Realm Controller Interface.

Hierarchy

• interface \VariableRealmControllerInterface

File

variable_realm/variable_realm.class.inc, line 10

Variable realm controller

interface VariableRealmControllerInterface {

  /**
   * Class constructor.
   *
   * @param $realm_name
   *   Realm name.
   * @param $store_class
   *   Realm key.
   */
  public function __construct($realm_name);

  /**
   * Check whether the realm is enabled (has a key set).
   */
  public function isEnabled();

  /**
   * Check whether the realm is active (has a valid key set).
   */
  public function isActive();

  /**
   * Start this realm with request key.
   *
   * This will only change the realm key if the realm is not initialized yet.
   */
  public function enable($realm_key = NULL);

  /**
   * Get title for this realm.
   */
  public function getTitle();

  /**
   * Get name for variables in this realm.
   */
  public function getVariableName();

  /**
   * Add store for realm key.
   *
   * @param $variables
   *   Optional array with variable values to initialize the realm key store.
   */
  public function addStore($realm_key, $variables = NULL);

  /**
   * Get store for realm key.
   */
  public function getStore($realm_key);

  /**
   * Set store for realm key.
   */
  public function setStore($realm_key, $realm_store);

  /**
   * Get current realm key.
   */
  public function getKey();

  /**
   * Get default key for this realm.
   */
  public function getDefaultKey();

  /**
   * Get key for this page request.
   */
  public function getRequestKey();

  /**
   * Set current realm key.
   */
  public function setKey($realm_key);

  /**
   * Get all keys for this realm.
   */
  public function getAllKeys();

  /**
   * Get other realms this one may depend upon.
   */
  public function getParentRealms();

  /**
   * Get current realm weight.
   */
  public function getWeight();

  /**
   * Set current realm weight.
   */
  public function setWeight($weight);

  /**
   * Implementation of VariableRealmControllerInterface::getWeight().
   */
  public function getDefaultWeight();

  /**
   * Get current variable store.
   */
  public function getCurrentStore();

  /**
   * List all current variable values.
   */
  public function getCurrentVariables();

  /**
   * Get information for this realm.
   *
   * Return information provided by hook_variable_realm_info()
   */
  public function getInfo($property = NULL, $default = NULL);

  /**
   * Get list of variables available for this realm.
   */
  public function getAvailableVariables();

  /**
   * Get list of variables enabled for this realm.
   */
  public function getEnabledVariables();

  /**
   * Get system variable for this realm.
   */
  public function getRealmVariable($name, $default = NULL);

  /**
   * Set system variable for this realm.
   */
  public function setRealmVariable($name, $value);

  /**
   * Delete variable for all keys this realm.
   *
   * @param $variable_name
   *   Variable name to delete.
   */
  public function deleteVariable($variable_name);

}

Members

Name	Modifiers	Type	Description	Overrides
VariableRealmControllerInterface::addStore	public	function	Add store for realm key.	1
VariableRealmControllerInterface::deleteVariable	public	function	Delete variable for all keys this realm.	1
VariableRealmControllerInterface::enable	public	function	Start this realm with request key.	1
VariableRealmControllerInterface::getAllKeys	public	function	Get all keys for this realm.	1
VariableRealmControllerInterface::getAvailableVariables	public	function	Get list of variables available for this realm.	1
VariableRealmControllerInterface::getCurrentStore	public	function	Get current variable store.	1
VariableRealmControllerInterface::getCurrentVariables	public	function	List all current variable values.	1
VariableRealmControllerInterface::getDefaultKey	public	function	Get default key for this realm.	1
VariableRealmControllerInterface::getDefaultWeight	public	function	Implementation of VariableRealmControllerInterface::getWeight().	1
VariableRealmControllerInterface::getEnabledVariables	public	function	Get list of variables enabled for this realm.	1
VariableRealmControllerInterface::getInfo	public	function	Get information for this realm.	1
VariableRealmControllerInterface::getKey	public	function	Get current realm key.	1
VariableRealmControllerInterface::getParentRealms	public	function	Get other realms this one may depend upon.	1
VariableRealmControllerInterface::getRealmVariable	public	function	Get system variable for this realm.	1
VariableRealmControllerInterface::getRequestKey	public	function	Get key for this page request.	1
VariableRealmControllerInterface::getStore	public	function	Get store for realm key.	1
VariableRealmControllerInterface::getTitle	public	function	Get title for this realm.	1
VariableRealmControllerInterface::getVariableName	public	function	Get name for variables in this realm.	1
VariableRealmControllerInterface::getWeight	public	function	Get current realm weight.	1
VariableRealmControllerInterface::isActive	public	function	Check whether the realm is active (has a valid key set).	1
VariableRealmControllerInterface::isEnabled	public	function	Check whether the realm is enabled (has a key set).	1
VariableRealmControllerInterface::setKey	public	function	Set current realm key.	1
VariableRealmControllerInterface::setRealmVariable	public	function	Set system variable for this realm.	1
VariableRealmControllerInterface::setStore	public	function	Set store for realm key.	1
VariableRealmControllerInterface::setWeight	public	function	Set current realm weight.	1
VariableRealmControllerInterface::__construct	public	function	Class constructor.	1