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

Class: Thread_Vars_Manager

Source Location: /web_site/thread_vars_manager.class.php

Class Thread_Vars_Manager

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

Thread Vars Manager (TVM)

Container for thread's variables

Located in /web_site/thread_vars_manager.class.php [line 30] 

Tangra_Class
   |
   --Vars_Manager
      |
      --Thread_Vars_Manager
Author(s):
API Tags:
See:  Threads_Manager

Properties

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods 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 ]
Property Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
array   $pages   Array that holds pages and their variables

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
mixed   &get_page_var()   Returns reference to page variable
Vars_Manager   &get_page_vm()   Returns reference to page Vars_Manager
mixed   &get_thread_var()   Returns reference to thread var
boolean   is_page_var_registered()   Checks if page variable is registered
boolean   is_thread_var_registered()   Checks if thread variable is registered
mixed   query_page_var()   Returns page variable
mixed   query_thread_var()   Returns thread variable
void   register_page_var()   Registers page variable
void   register_thread_var()   Registers thread var
void   remove_page_var()   Removes page variable
void   remove_thread_var()   Removes thread variable
void   set_page_var()   Sets page variable value
void   set_thread_var()   Sets thread var value
boolean   var_exists()   Alias of is_thread_var_registered()

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

Array that holds pages and their variables

API Tags:
Internal:  
Access:  private


[ Top ]
Methods
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
get_page_var  [line 215]

  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 194]

  Vars_Manager &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 ]
get_thread_var  [line 67]

  mixed &get_thread_var( string $var_name  )

Returns reference to thread var

Parameters:
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
is_page_var_registered  [line 159]

  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 ]
is_thread_var_registered  [line 102]

  boolean is_thread_var_registered( string $var_name  )

Checks if thread variable is registered

Parameters:
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
query_page_var  [line 232]

  mixed query_page_var( string $page_name, string $var_name  )

Returns page variable

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

API Tags:
Access:  public


[ Top ]
query_thread_var  [line 79]

  mixed query_thread_var( string $var_name  )

Returns thread variable

Parameters:
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
register_page_var  [line 124]

  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 ]
register_thread_var  [line 45]

  void register_thread_var( string $var_name  )

Registers thread var

Parameters:
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
remove_page_var  [line 143]

  void remove_page_var( string $page_name, string $var_name  )

Removes 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 ]
remove_thread_var  [line 91]

  void remove_thread_var( string $var_name  )

Removes thread variable

Parameters:
string   $var_name:  Variable name

API Tags:
Access:  public


[ Top ]
set_page_var  [line 178]

  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 ]
set_thread_var  [line 56]

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

Sets thread var value

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

API Tags:
Access:  public


[ Top ]
var_exists  [line 113]

  boolean var_exists( string $var_name  )

Alias of is_thread_var_registered()

Parameters:
string   $var_name: 

API Tags:
Access:  public


[ Top ]