Packageindex Classtrees Modulegroups Elementlist Report XML Files

Site

Site

private class Site

 

Public Method Summary

void Site()
Constructor
object Site &singleton()
Instantiate one copy of this object.
object Request &getRequest()
Gets the top-level (page-request-level) Request object.
void setRequest(object Request &$new)
Sets the top-level Request object.
void errorHandler(object PEAR $err)
This is the error-handler function registered w/ PHP.
object Site &getCache()
Gets the PEAR::Cache instance.
void setCache(object PEAR $new)
Set the PEAR::Cache instance to use
boolean setCacheFlushed([ boolean $is_flushed, string $group ])
Set whether cache has been flushed in this request or not
boolean isCacheFlushed([ string $group ])
Retuns whether the cache has been flushed of not. Defaults to false.
object reference &getUser()
Gets the currently logged-in user (pxdb_user) if set.

Private Method Summary

boolean shutdown()
This is the shutdown function registered w/ PHP.

Private Field Summary

$Request
Top-level Request object.
$Cache
Global Cache_Output object.
$User
The pxdb_user object
array $cacheFlushed
Holds page-request wide status of cache flushing

Public Method Details

Site

public void Site()

 

Returns void


&singleton

public object Site &singleton()

 

Returns object Site


&getRequest

public object Request &getRequest()

 

Returns object Request


setRequest

public void setRequest(object Request &$new)

  This is the Request that actually fetched current page. Within a given page $Request may be re-instantiated to perform custom work.

Parameter
object Request &$new
Returns void


errorHandler

public void errorHandler(object PEAR $err)

  This function is bound to PEAR::Error AND to PHP's standard error, which means that it can take either 1 hash param (PEAR) or many params (PHP).

Parameter
object PEAR $err
::Error
Returns void


&getCache

public object Site &getCache()

 

Returns object Site


setCache

public void setCache(object PEAR $new)

 

Parameter
object PEAR $new
::Cache::Output &$new class
Returns void


setCacheFlushed

public boolean setCacheFlushed([ boolean $is_flushed, string $group ])

 

Parameter
boolean $is_flushed = >>false<<
string $group = >>null<<
The group to set (optional but strongly recommended).
Returns boolean

success (true) or error (false)


isCacheFlushed

public boolean isCacheFlushed([ string $group ])

  If no group is provided, it checks to see if any group has been flushed.

Parameter
string $group = >>null<<
The group to check.
Returns boolean


&getUser

public object reference &getUser()

  This is just for convenience -- the actual value is not stored as part of the site object, but rather is derived from pxdb_user::existant().

Returns object reference

pxdb_user


Private Method Details

shutdown

private boolean shutdown()

  The most important thing (currently) that this function does is log any errors to php_errors.log in SITE_LOG_PATH.

Returns boolean

Success


Private Field Details

$Request

private $Request

>>null<<


$Cache

private $Cache

>>null<<


$User

private $User

>>null<<


$cacheFlushed

private array $cacheFlushed

>>array()<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
Generated on Fri, 28 Apr 2006 19:06:12 -0400 by PHPDoc v1.5 www.phpdoc.de