blueshoes php application framework and cms            core_lang
[ class tree: core_lang ] [ index: core_lang ] [ all elements ]

Class: Page

Source Location: /toolbox/phppackager/pages/Page.class.php

Class Overview

Bs_Object
   |
   --Page

*************************************************************************************************** It only holds the repetetive stuff we would otherwise copy in each Page we want to render.


Author(s):

Version:

  • 1-$id$ ****************************************************************************************************

Copyright:

  • blueshoes.org

Variables

Methods


Inherited Variables

Inherited Methods

Class: Bs_Object

Bs_Object::Bs_Object()
Bs_Object::getErrors()
Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack.
Bs_Object::getLastError()
Basic error handling: Get last error string from the global Bs_Error-error stack.
Bs_Object::getLastErrors()
Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors().
Bs_Object::persist()
Persists this object by serializing it and saving it to a file with unique name.
Bs_Object::setError()
Basic error handling: Push an error string on the global Bs_Error-error stack.
Bs_Object::toHtml()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::toString()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::unpersist()
Fetches an object that was persisted with persist()

Class Details

[line 12]
*************************************************************************************************** It only holds the repetetive stuff we would otherwise copy in each Page we want to render.



Tags:

copyright:  blueshoes.org
version:  1-$id$ ****************************************************************************************************
author:  samuel blume <mailto:sb@4matics.ch>


[ Top ]


Class Variables

$todo =

[line 49]

gets set in the constructor. the output of bs_requestToDo().


Type:   array


[ Top ]

$_dbAgent =  NULL

[line 17]

The dbAgent, that is used to read-out the data form the DB.


Type:   mixed


[ Top ]

$_metaNavigation =  ''

[line 42]

comes from the session, set in setSessionData().

Used on every page e.g.



Type:   sting


[ Top ]

$_sessionData =

[line 22]

comes from the session, set in setSessionData().


Type:   mixed


[ Top ]

$_user =

[line 28]

comes from the session, set in setSessionData().



Tags:

var:  Sm_User

Type:   object of


[ Top ]

$_userFooter =  ''

[line 35]

comes from the session, set in setSessionData().

Used on every page e.g. Robert Mwangi - Account expires on 08/12/2005



Type:   sting


[ Top ]



Class Methods


constructor Page [line 55]

Page Page( )

Constructor



[ Top ]

method setDbAgent [line 71]

void setDbAgent( $dbAgent &$dbAgent)

Sets the dbAgent, that is used to read-out the data form the DB.

Nice sample for information hiding: The dbAgent can be any specialized DB-agent like a DB2- or MySql-Agent. NOTE: *MUST* be set if you plan to use real data. See render




Parameters:

$dbAgent   &$dbAgent   object An Db-Agent (see text above)

[ Top ]

method setSessionData [line 110]

void setSessionData( $sessionData &$sessionData)

Passes the session-hash to this instance, so it can pick out the information it needs. Depending on what we need to, this can range from a singe value to the whole session data.



Tags:

see:  SET_EntryPoint for more details on the session stucture. READ ONLY data we expect to get: $sessionData['user'] // Instance of currently logged in user (Sm_User.class.php) $sessionData['evalName'] // Name of the current evaluation


Parameters:

$sessionData   &$sessionData   hash. See text above.

[ Top ]

method _getMetaNavigation [line 82]

void _getMetaNavigation( $user 0, $currentScreen 1, $addQuickHelp 2)

Build the meta navitation. Used by pages that inherit this class



Parameters:

$user   0   object An SM_User-Agent
$currentScreen   1   string The nextscreen in the ToDo hash ()Will become this screen
$addQuickHelp   2   bool Add the quick help javascript calls or not

[ Top ]


Documentation generated on Mon, 29 Dec 2003 21:15:41 +0100 by phpDocumentor 1.2.3