Docs For Class Object

Description

Object Class

Every instantiated class in PICKLES should be extending this class. By doing so the class is automatically hooked into the profiler, and the object will have access to some common components as well.

Located in /classes/Object.php (line 25)

Direct descendents

Class	Description
Display_Common	Common Display Class
Database_Common	Common Database Abstraction Layer
Module	Module Class
Controller	Controller Class
Database	Database Factory
Config	Config Class
Form	Form Class
Model	Model Class
Dynamic	Dynamic Class

Variable Summary

static mixed $instances

object $config

Method Summary

static object instance getInstance ([string $class = false])

Object __construct ()

void __destruct ()

Variables

static mixed $instances = array() (line 34)

Object Instances

access: protected

object $config = null (line 42)

Instance of the Config object

access: protected

Methods

static method getInstance (line 78)

Get Instance

Gets an instance of the passed class. Allows for easy sharing of certain classes within the system to avoid the extra overhead of creating new objects each time. Also avoids the hassle of passing around variables.

return: of the class
access: public

static object instance getInstance ([string $class = false])

string $class: name of the class

Redefined in descendants as:

Database::getInstance() : Get instance
Config::getInstance() : Get instance of the object
Form::getInstance() : Get Instance

Constructor __construct (line 49)

Constructor

Establishes a Config instance for all children to enjoy

access: public

Object __construct ()

Redefined in descendants as:

Display_Common::__construct() : Constructor
Database_Common::__construct() : Constructor
Database_PDO_Common::__construct() : Constructor
Module::__construct() : Constructor
Controller::__construct() : Constructor
Database::__construct() : Constructor
Config::__construct() : Constructor
Model::__construct() : Constructor

Destructor __destruct (line 99)

Destructor

access: public

void __destruct ()

Redefined in descendants as:

Controller::__destruct()