interface VariableRealmControllerInterface in Variable 7

Realm Controller Interface.

Hierarchy

• interface \VariableRealmControllerInterface

File

variable_realm/variable_realm.class.inc, line 10

Variable realm controller

interface VariableRealmControllerInterface {

  /**
   * Class constructor.
   *
   * @param $realm
   *   Realm name.
   * @param $key
   *   Realm key.
   * @param $variables
   *   Optional array of variables to initialize the realm with.
   */
  public function __construct($realm, $key, $variables = NULL);

  /**
   * Initialize variables.
   */
  public function variable_init();

  /**
   * Get single variable.
   *
   * @param $name
   *   Variable name
   * @param $default
   *   Default value
   */
  public function variable_get($name, $default = NULL);

  /**
   * Set single variable.
   *
   * @param $name
   *   Variable name
   * @param $value
   *   Variable value
   */
  public function variable_set($name, $value);

  /**
   * Delete single variable.
   *
   * @param $name
   *   Variable name
   */
  public function variable_del($name);

  /**
   * Add single variable to the realm for current request.
   *
   * While variable set actually sets the variable on whatever realm storage
   * we are using, this function just sets a runtime value.
   *
   * @param $name
   *   Variable name
   * @param $value
   *   Variable value
   */
  public function variable_add($name, $value);

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

}

Members

Name	Modifiers	Type	Description	Overrides
VariableRealmControllerInterface::variable_add	public	function	Add single variable to the realm for current request.	1
VariableRealmControllerInterface::variable_del	public	function	Delete single variable.	1
VariableRealmControllerInterface::variable_get	public	function	Get single variable.	1
VariableRealmControllerInterface::variable_init	public	function	Initialize variables.	1
VariableRealmControllerInterface::variable_list	public	function	List all current variable values.	1
VariableRealmControllerInterface::variable_set	public	function	Set single variable.	1
VariableRealmControllerInterface::__construct	public	function	Class constructor.	1