Welcompose
[ class tree: Welcompose ] [ index: Welcompose ] [ all elements ]

Class: Base_Base

Source Location: /base_classes/base.class.php

Class Overview




Variables

Methods



Class Details

[line 38]


[ Top ]


Class Variables

static $instance =  null

[line 45]

Singleton



Tags:

access:  public

Type:   object


[ Top ]

$db =  null

[line 66]

Reference to database class



Tags:

access:  public

Type:   obejct


[ Top ]

$error =  null

[line 59]

Reference to error handling class



Tags:

access:  public

Type:   object


[ Top ]

$utility =  null

[line 52]

Reference to Base_Utility class



Tags:

access:  public

Type:   object


[ Top ]

$_conf = array()

[line 80]

container for configuration settings



Tags:

access:  public

Type:   array


[ Top ]

$_debug =  false

[line 73]

debug mode setting



Tags:

access:  protected

Type:   bool


[ Top ]

$_defaults = array()

[line 87]

container for default values



Tags:

access:  public

Type:   array


[ Top ]



Class Methods


static method instance [line 127]

static object instance( )

Singleton

Returns instance of the base object.




Tags:

access:  public


[ Top ]

constructor __construct [line 89]

Base_Base __construct( )



Tags:

access:  public


[ Top ]

method configureLocales [line 351]

bool configureLocales( )

Configure locales

Configures locales according to the settings in BASE::_conf['locales']. It loops through BASE::_conf['locales'] and looks for the following config keys:

  • all: Setting for LC_ALL
  • collate: Setting for LC_COLLATE
  • cytpe: Setting for LC_CTYPE
  • monetary: Setting for LC_MONETARY
  • numeric: Setting for LC_NUMERIC
  • time: Setting for LC_TIME




Tags:

access:  protected


[ Top ]

method debug_enabled [line 417]

bool debug_enabled( )

Debug enabled

Read only interface to the protected property BASE::_debug. Returns whether the debug mode is enabled or off.




Tags:

access:  public


[ Top ]

method loadClass [line 257]

void loadClass( string $class)

Load class

Loads requested class. Takes the class name as first argument. Supported class names:

  • cnc
  • database
  • error
  • utility




Tags:

access:  public


Parameters:

string   $class   Class name

[ Top ]

method loadConfiguration [line 195]

bool loadConfiguration( )

Load configuration

Loads configuration information from sys.inc.php and attaches the contents to BASE::_conf. It also takes care of configuring the settings for debug and development modes.




Tags:

access:  protected


[ Top ]

method loadConstants [line 171]

bool loadConstants( )

Load constants

Loads files with constants (regex etc.).




Tags:

access:  protected


[ Top ]

method loadDefaults [line 225]

bool loadDefaults( )

Load defaults

Load default settings from defaults.inc.php and attaches them to BASE::_defaults.




Tags:

access:  protected


[ Top ]

method reconfigureLocales [line 433]

bool reconfigureLocales( )

Reconfigure Locales

Interface to BASE::configureLocales();




Tags:

access:  public


[ Top ]

method reloadConfiguration [line 443]

bool reloadConfiguration( )

Public interface to Base_Base::loadConfiguration();



Tags:

access:  public


[ Top ]

method setIncludePath [line 150]

void setIncludePath( )

Set include path

Configures new include paths. Defines the following paths:

  • Same directory (.)
  • Parent directory (../)
  • PEAR directory (../pear)

The function will only be executed when base::_use_ini_set is true.




Tags:

access:  protected


[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:41 +0100 by phpDocumentor 1.4.3