tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Class: Session_Vars_Manager

Source Location: /web_site/session_vars_manager.class.php

Class Session_Vars_Manager

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail | Constants Summary | Constants Detail

Session Variables Manager

Session Variables Manager or SVM is a container for session variables. It's purpose is to separate user from built-in variable $_SESSION. That way SVM object can be passed as parameter to functions that require session variables and this can be used for automated testing (passing "fake" SVM object, i.e. prepared manually).

General idea is users to be forced to use SVM. Og course they can use $_SESSION too but this is considered sloppy.

Located in /web_site/session_vars_manager.class.php [line 37] 

Tangra_Class
   |
   --Vars_Manager
      |
      --Session_Vars_Manager

Properties

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail | Constants Summary | Constants Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Vars_Manager

Vars_Manager::$atimes
Vars_Manager::$gc_maxlifetime
Vars_Manager::$vars

Inherited From Vars_Manager

Vars_Manager::__construct()
Constructor
Vars_Manager::add_var()
Adds new variable. Shortcut for register_var() and set_var()
Vars_Manager::garbage_collector()
Collects the garbage.
Vars_Manager::get_var()
Gets variable as reference. Use this function if you intend to change the value.
Vars_Manager::is_var_registered()
Checks if variable with name provided by $var_name exists.
Vars_Manager::query_var()
Query variable. Similar to get_var() but returns copy of the variable, not reference. Use this function instead of get_var() if you are not intending to change the value.
Vars_Manager::register_var()
Registers variable. You have first to register variable before using Vars_Manager::set_var()
Vars_Manager::remove_var()
Removes/unregisters variable.
Vars_Manager::set_var()
Sets variable.

Inherited From Tangra_Class

Tangra_Class::get_class_name()
Alias of get_class(). Exist because of historical reasons.
Tangra_Class::__set()
Overides PHP built-in method and just throws exception if called. Purpose - to "forbid" autosetting of nonexisting class properties.

[ Top ]
Constant Summary
Class Overview | Inherited Properties, Constants, and Methods | Constants Summary | Constants Detail | Property Summary | Properties Detail | Method Summary | Methods Detail
VAR_NAME   SVM variable name in $_SESSION

[ Top ]
Property Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail | Constants Summary | Constants Detail
array   $pages   Array that holds pages and their variables

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Constants Summary | Constants Detail | Method Summary | Methods Detail
static Session_Vars_Manager   &get_session_vars_manager()   Returns reverence to SVM
static unknown   get_svm_var_name()   Returns SVM variable name in $_SESSION
static Session_Vars_Manager   query_session_vars_manager()   Returns current Session_Vars_Manager
mixed   &get_global_var()   Returns reference to global variable
mixed   &get_page_var()   Returns reference to page variable
mixed   &get_page_vm()   Returns reference to page vars manager
boolean   is_global_var_registered()   Checks if global variable is registered
boolean   is_page_var_registered()   Checks if page variable is registered
void   register_global_var()   Registers global variable
void   register_page_var()   Registers page variable
void   remove_global_var()   Removes global variable
void   set_global_var()   Sets value for global variable
void   set_page_var()   Sets page variable value

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail | Constants Summary | Constants Detail
array   $pages = array() [line 50]

Array that holds pages and their variables

API Tags:
Internal:  
Access:  private


[ Top ]
Methods
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Constants Summary | Constants Detail | Method Summary | Methods Detail
static method get_session_vars_manager  [line 216]

  static Session_Vars_Manager &get_session_vars_manager( Web_Context $context  )

Returns reverence to SVM

Parameters:
Web_Context   $context: 

API Tags:
Access:  public


[ Top ]
static method get_svm_var_name  [line 205]

  static unknown get_svm_var_name( )

Returns SVM variable name in $_SESSION


API Tags:
Access:  public


[ Top ]
static method query_session_vars_manager  [line 232]

  static Session_Vars_Manager query_session_vars_manager( Web_Context $context  )

Returns current Session_Vars_Manager

Parameters:
Web_Context   $context: 

API Tags:
Access:  public


[ Top ]
get_global_var  [line 82]

  mixed &get_global_var( string $var_name  )

Returns reference to global variable

Parameters:
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
get_page_var  [line 190]

  mixed &get_page_var( string $page_name, string $var_name  )

Returns reference to page variable

Parameters:
string   $page_name:  Page name
string   $var_name:  Variable name

API Tags:
Access:  public

Information Tags:
Throws:  TE_Page_Not_Registered

[ Top ]
get_page_vm  [line 169]

  mixed &get_page_vm( string $page_name  )

Returns reference to page vars manager

Parameters:
string   $page_name:  Page name

API Tags:
Access:  public

Information Tags:
Throws:  TE_Page_Not_Registered

[ Top ]
is_global_var_registered  [line 104]

  boolean is_global_var_registered( string $var_name  )

Checks if global variable is registered

Parameters:
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
is_page_var_registered  [line 134]

  boolean is_page_var_registered( string $page_name, string $var_name  )

Checks if page variable is registered

Parameters:
string   $page_name:  Page name
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
register_global_var  [line 60]

  void register_global_var( string $var_name  )

Registers global variable

You have first to register given variable before using it.

 Parameters:
string   $var_name: 

API Tags:
Access:  public


[ Top ]
register_page_var  [line 115]

  void register_page_var( string $page_name, string $var_name  )

Registers page variable

Parameters:
string   $page_name:  Page name
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
remove_global_var  [line 93]

  void remove_global_var( string $var_name  )

Removes global variable

Parameters:
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
set_global_var  [line 71]

  void set_global_var( string $var_name, &$value, mixed $value  )

Sets value for global variable

Parameters:
string   $var_name:  Variable name
mixed   $value:  Value for variable
   &$value: 

API Tags:
Access:  public


[ Top ]
set_page_var  [line 153]

  void set_page_var( string $page_name, string $var_name, &$value, mixed $value  )

Sets page variable value

Parameters:
string   $page_name:  Page name
string   $var_name:  Variable name
mixed   $value:  Variable value
   &$value: 

API Tags:
Access:  public

Information Tags:
Throws:  TE_Page_Not_Registered

[ Top ]
Constants
Class Overview | Constants Summary | Constants Detail | Inherited Properties, Constants, and Methods | Method Summary | Methods Detail
VAR_NAME = '_svm' [line 42]

SVM variable name in $_SESSION


[ Top ]