Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

enviroment Class Reference

Represents enviroment. More...

Inherits fa_xep_user.

Inheritance diagram for enviroment:

Inheritance graph
List of all members.

Public Methods

function set_entities ()
 Register entities.

function process_template (filename)
 Process template.

function process_locations ()
 Process locations gathered during import.

function location (name)
 Return location.

function start (data)
 Initialize enviroment.

function authentificate ()
 Provide user authentification.

function do_auth_failure (reason)
 Authentification failure respond.

function run (data)
 Run.

function choose_model (name)
 Choose model and check choice.

function do_it (data)
 Action method.

function import (fname)
 Import data.

function & produce (data)
 Produce state.

function err (what, func='', line=0, file='', terminate=1)
 Log error.


Public Attributes

var properties = array()
 Enviroment configuration.

var locations = array()
 Locations configuration.

var user
 User.

var templates_handler = 0
 Templates handler.

var entities = array()
 Template entities.

var xml_parser
 xml parser.

var iname = ''
 Name of imported file.


Detailed Description

Represents enviroment.

This class is a representation of system that provides configuration of system, user authentification and models choosing.

Definition at line 21 of file enviroment.php.


Member Function Documentation

function process_template filename   
 

Process template.

Process HTML template converting entities.

Parameters:
filename  - template file name
Returns:
string contains processed template
See also:
set_entities(), templates_handler

Definition at line 61 of file enviroment.php.

Referenced by choose_model(), do_auth_failure(), process_template(), and run().

function location name   
 

Return location.

Parameters:
string  name - name of location to return.

Definition at line 95 of file enviroment.php.

Referenced by location(), and process_locations().

function authentificate  
 

Provide user authentification.

Returns:
authentification status
See also:
auth_constants.php

Definition at line 115 of file enviroment.php.

Referenced by run().

function do_auth_failure reason   
 

Authentification failure respond.

Parameters:
reason  - failure reason
See also:
auth_constants.php

Definition at line 161 of file enviroment.php.

Referenced by run().

function do_it data   
 

Action method.

See also:
start(), run()

Reimplemented from final_automat.

Definition at line 426 of file enviroment.php.

function import fname    [inherited]
 

Import data.

Parameters:
string  fname - name of xml file to import

Reimplemented in model_explore.

Definition at line 25 of file fa_xep_user.php.

function& produce data    [inherited]
 

Produce state.

Produce state according to data.

Parameters:
data  - any data identificating state
Returns:
next step object according to requested state

Reimplemented in model_abstract, model_explore, and model_querry.

Definition at line 30 of file final_automat.php.

function err what   ,
func    = '',
line    = 0,
file    = '',
terminate    = 1
[inherited]
 

Log error.

Parameters:
what  - error reason
func  - function name in which an error had uccured
line  - source line
file  - name of source file
terminate  - 1 to terminate script processing
Returns:
zero

Definition at line 23 of file error_logger.php.

Referenced by user_auth::authentificate(), cache_container::clear(), model_querry::get(), cache_container::get(), models::get_info(), models::get_relations(), xml_event_parser_user::import(), model_explore::import(), location(), xml_structure_builder::parse(), xml_event_parser::parse(), xml_structure_builder::parse_file(), xml_event_parser::parse_file(), models::pre_cache(), template_handler::process_file(), process_locations(), model_explore::process_template(), process_template(), and models::read_cache().


The documentation for this class was generated from the following file:
Generated on Tue Mar 11 08:35:18 2003 for SES by doxygen1.2.16