Docs For Class Sourdough

Description

SOURDOUGH global framework object

This global framework object represents a flyweight factory that creates and returns object references. Using the flyweight pattern ensures that only objects are generated that are actually used. Dependencies to other objects are resolved in the objects themselves by passing over a member of the global framework object. Got that?!

author: Philip Iezzi <at phpee dot com pipo at phpee dot com>
version: $Id: Sourdough.class.php 3003 2007-12-08 11:05:17Z piezzi $
copyright: Copyright (c) 2001-2007 PHPEE.COM
license: GNU Lesser General Public License

Located in /Sourdough.class.php (line 50)

Class Constant Summary

SD_AUTH = 'Auth'

SD_BBCODE = 'BBcode'

SD_CAPTCHA = 'Captcha'

SD_DB = 'Db'

SD_DIRSCAN = 'DirScan'

SD_FILECONVERT = 'FileConvert'

SD_FORMMAIL = 'FormMail'

SD_FORMS = 'Forms'

SD_HTML = 'Html'

SD_IMAGE = 'Image'

SD_LINECOUNT = 'LineCount'

SD_PATFORMS = 'PatForms'

SD_PATTEMPLATE = 'PatTemplate'

SD_SAVANTTEMPLATE = 'SavantTemplate'

SD_SESSION = 'Session'

SD_SETTINGS = 'Settings'

SD_SQLHELPER = 'SqlHelper'

SD_TEMPLATE = 'Template'

SD_USER = 'User'

SD_XSLT = 'Xslt'

SD_YABD = 'Yabd'

Method Summary

mixed getConf ([string $key = null])

void getFlyweight (string $key, [array $args = null])

void loadConfig (array $customConf)

Sourdough __construct ([array $customConf = ''])

void __call (string $name, array $args)

Methods

getConf (line 310)

Get configuration parameter

access: public

mixed getConf ([string $key = null])

string $key: configuration key

getFlyweight (line 216)

Get an instance of a Sourdough framework class

TODO: Exception handling if called class does not exist

access: public

void getFlyweight (string $key, [array $args = null])

string $key: class identifier constant
array $args: arguments

loadConfig (line 298)

Get configuration parameter

access: public

void loadConfig (array $customConf)

array $customConf: custom configuration

Constructor __construct (line 165)

Sourdough constructor

Get default configuration options and merge them with custom supplied options. Set up the whole Sourdough environment.

access: public

Sourdough __construct ([array $customConf = ''])

array $customConf: custom configuration

__call (line 204)

Class method overloader

access: public

void __call (string $name, array $args)

string $name: name
array $args: arguments

Class Constants

SD_AUTH = 'Auth' (line 58)

SD_BBCODE = 'BBcode' (line 56)

SD_CAPTCHA = 'Captcha' (line 69)

SD_DB = 'Db' (line 72)

SD_DIRSCAN = 'DirScan' (line 53)

SD_FILECONVERT = 'FileConvert' (line 65)

SD_FORMMAIL = 'FormMail' (line 60)

SD_FORMS = 'Forms' (line 55)

SD_HTML = 'Html' (line 67)

SD_IMAGE = 'Image' (line 68)

SD_LINECOUNT = 'LineCount' (line 66)

SD_PATFORMS = 'PatForms' (line 64)

SD_PATTEMPLATE = 'PatTemplate' (line 62)

SD_SAVANTTEMPLATE = 'SavantTemplate' (line 63)

SD_SESSION = 'Session' (line 52)

SD_SETTINGS = 'Settings' (line 54)

SD_SQLHELPER = 'SqlHelper' (line 71)

SD_TEMPLATE = 'Template' (line 61)

SD_USER = 'User' (line 59)

SD_XSLT = 'Xslt' (line 70)

SD_YABD = 'Yabd' (line 57)