Axiom (v1.2.0)

A lightweight PHP framework
Axiom Class Reference

Main framework class. More...

Static Public Member Functions

static configuration ()
 Get the configuration object.
static library ()
 Get the library object.
static locale ()
 Get the localization object.
static database ()
 Get the database connection object.
static session ()
 Get the session object.
static log ()
 Get the log object.
static captcha ()
 Get the captcha object.
static module ()
 Get the module manager object.
static view ()
 Get the view manager.

Data Fields

const VERSION = '1.2.0'
 Axiom Framework Version.

Static Public Attributes

static $cache = true
 Flag used to toggle cache.

Static Private Attributes

static $_config
 Configuration object.
static $_library
 Library object.
static $_locale
 Localization object.
static $_database
 Database connection object.
static $_session
 Session object.
static $_log
 Log object.
static $_captcha
 Captcha object.
static $_module
 Module Manager object.
static $_view
 View Manager object.

Detailed Description

Main framework class.

This class is a front-end to the most used class in the Axiom framework. It provides direct access to

This class is also a bridge between the different libraries compounded in the framework and their configuration that is being held by the axConfiguration object. Axiom class brings all these items together so you don't have to setup the configuration manually.

Author:
Delespierre
Since:
1.2.0

Definition at line 32 of file Axiom.class.php.


Member Function Documentation

static Axiom::captcha ( ) [static]

Get the captcha object.

If the captcha object is not defined, it will be initialized using the configuration parameters (see Axiom::configuration).

Returns:
axCaptcha

Definition at line 268 of file Axiom.class.php.

static Axiom::configuration ( ) [static]

Get the configuration object.

If the configuration object is not defined it will be initialized according to the method parameters. If no parameter is provided for the first call (implicit initialization) then the default parameters will be used.

Parameters:
string$file[optional] [default "/application/config/config.ini"] The configuration file to be used
string$section[optional] [default "default"] The configuration section to be used
string$class[optional] [default "axIniConfiguration"] The configuration class to be used
Exceptions:
RuntimeExceptionIf the configuration class cannot be found
Returns:
axConfiguration

Definition at line 121 of file Axiom.class.php.

static Axiom::database ( ) [static]

Get the database connection object.

If the database connection object is not defined, it will be initialized using the configuration parameter (see Axiom::configuration). When calling Axiom::database for the first time, you may pass an array as only parameter, this array will be used as the $driver_options parameters of the PDO constructor (see http://www.php.net/manual/en/pdo.construct.php}).

Parameters:
array$driver_options[optional] [default array()] The driver options
Exceptions:
PDOExceptionIf the database connection object construction fails
Returns:
axDatabase

Definition at line 199 of file Axiom.class.php.

static Axiom::library ( ) [static]

Get the library object.

If the library object is not defined it will be initialized. No parameter is required to initialize the library object. Calling this method for the first time will register the library object as default Autoloader for PHP.

Returns:
axLibrary

Definition at line 147 of file Axiom.class.php.

static Axiom::locale ( ) [static]

Get the localization object.

If the localization object is not defined, it will be initialized using the configuration parameters (see Axiom::configuration).

Returns:
axLocale

Definition at line 166 of file Axiom.class.php.

static Axiom::log ( ) [static]

Get the log object.

If the log object is not defined, it will be initialized using the configuration parameters (see Axiom::configuration).

Returns:
axLog

Definition at line 243 of file Axiom.class.php.

static Axiom::module ( ) [static]

Get the module manager object.

If the module manager object is not defined, it will be initialized using the configuration parameters (see Axiom::configuration).

Returns:
axModuleManager

Definition at line 293 of file Axiom.class.php.

static Axiom::session ( ) [static]

Get the session object.

If the session object is not defined, it will be initialized using the configuration parameters (see Axiom::configuration).

Returns:
axSession

Definition at line 224 of file Axiom.class.php.

static Axiom::view ( ) [static]

Get the view manager.

If the view manager object is not defined, it will be initialized using the configuration parameters (see Axiom::configuration).

Returns:
axViewManager

Definition at line 317 of file Axiom.class.php.


Field Documentation

axCaptcha Axiom::$_captcha [static, private]

Captcha object.

Definition at line 92 of file Axiom.class.php.

axConfiguration Axiom::$_config [static, private]

Configuration object.

Definition at line 50 of file Axiom.class.php.

axDatabase Axiom::$_database [static, private]

Database connection object.

Definition at line 71 of file Axiom.class.php.

axLibrary Axiom::$_library [static, private]

Library object.

Definition at line 57 of file Axiom.class.php.

axLocale Axiom::$_locale [static, private]

Localization object.

Definition at line 64 of file Axiom.class.php.

axLog Axiom::$_log [static, private]

Log object.

Definition at line 85 of file Axiom.class.php.

axModuleManager Axiom::$_module [static, private]

Module Manager object.

Definition at line 99 of file Axiom.class.php.

axSession Axiom::$_session [static, private]

Session object.

Definition at line 78 of file Axiom.class.php.

axViewManager Axiom::$_view [static, private]

View Manager object.

Definition at line 106 of file Axiom.class.php.

boolean Axiom::$cache = true [static]

Flag used to toggle cache.

Definition at line 43 of file Axiom.class.php.

const Axiom::VERSION = '1.2.0'

Axiom Framework Version.

Definition at line 37 of file Axiom.class.php.


The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables