Docs For Class INFA_CMS

Interface INFA_CMS_PAGE

Description

openCSP interface INFA_CMS_PAGE

author: Peter Krebs <pitlinz@users.sourceforge.net>
version: $Id: INFA_CMS_PAGE.phpclass,v 1.7 2008/08/16 09:21:12 pitlinz Exp $
since: pk-16.06.2008
project: Open CSP-Management
license: GNU Public License

Located in /cms/page/INFA_CMS_PAGE.phpclass (line 39)

Direct descendents

Class	Description
INFA_MOD_CMS_PAGE	openCSP interface file

Method Summary

boolean curUserCanOpen ([boolean $debug = False])

void execPrependCmds ([boolean $debug = False])

array getChaTemplates ([bool $debug = False], [boolean $getAll = False])

string getContent ([int $chaShowMode = 0], [boolean $debug = False])

boolean getContentCalled ()

array getDBRow ([bool $withoutNull = True], [bool $debug = False])

CMS_PAGE_FORM &getForm ([int $mode = FRM_MODE_READONLY], [string $frmName = ''], [string $frmClass = 'CMS_PAGE_FORM'], [boolean $debug = False])

int getId ()

int getMenId ()

CMS_HTML_PAGE getMyHTMLPage ()

CMS_MENU_NODE &getMyMenuNode ([boolean $debug = False])

CMS_PROJECT &getMyProject ([boolean $setAsCurrent = False], [boolean $debug = False], [boolean $forceObj = True])

string getPreviewUri ()

int getProjId ([boolean $debug = False])

int getStateId ()

CMS_PAGE_TEMPLATE &getTemplate ([boolean $debug = False])

int getTemplateId ([boolean $debug = False])

string getTitle ([ $debug = False])

boolean isCurrent ([boolean $debug = False])

boolean isExpired ([boolean $debug = False])

boolean isOnline ([boolean $debug = False])

void setContentCalled ([boolean $called = 'True'])

boolean setDBRow (array $row, [boolean $asPopulated = True], [boolean $debug = False])

boolean setDBVal (array $valArr, [boolean $debug = False])

void setId (int $aId)

void setMenId (int $aId)

void setMyHTMLPage ( &$aHTMLPage, CMS_HTML_PAGE $aHTMLPage)

void setMyMenuNode ( &$aNode, [boolean $debug = False], CMS_MENU_NODE $aNode)

void setMyProject (CMS_PROJECT &$aProjObj, [boolean $debug = False])

void setProjId ($aId $aId)

Methods

curUserCanOpen (line 299)

returns if the current user can open the page

access: public

boolean curUserCanOpen ([boolean $debug = False])

boolean $debug

execPrependCmds (line 324)

executes a prepend script before the page output starts

void execPrependCmds ([boolean $debug = False])

boolean $debug

getChaTemplates (line 384)

returns an array of chapter template names with chapter template ID as index returns false if the page does not support chapter input

access: public

array getChaTemplates ([bool $debug = False], [boolean $getAll = False])

bool $debug
boolean $getAll

getContent (line 347)

returns the content

return: (html)

string getContent ([int $chaShowMode = 0], [boolean $debug = False])

int $chaShowMode
boolean $debug

getContentCalled (line 102)

has the method getContent been called?

access: public

boolean getContentCalled ()

getDBRow (line 128)

returns a field => value array as stored in the db

ensure PAG_OBJECTVARS is serialized with the current values

access: public

array getDBRow ([bool $withoutNull = True], [bool $debug = False])

bool $withoutNull: null values are not added to the array
bool $debug: show debug info?

getForm (line 171)

returns the form for the page

requires: CMS_PAGE_FORM
access: public

CMS_PAGE_FORM &getForm ([int $mode = FRM_MODE_READONLY], [string $frmName = ''], [string $frmClass = 'CMS_PAGE_FORM'], [boolean $debug = False])

int $mode: (form mode)
string $frmName
string $frmClass
boolean $debug

getId (line 74)

returns the page id

access: public

int getId ()

getMenId (line 229)

returns the cms menu id

int getMenId ()

getMyHTMLPage (line 336)

CMS_HTML_PAGE getMyHTMLPage ()

getMyMenuNode (line 247)

returns the menu node of the object

CMS_MENU_NODE &getMyMenuNode ([boolean $debug = False])

boolean $debug

getMyProject (line 206)

returns the Project Object

CMS_PROJECT &getMyProject ([boolean $setAsCurrent = False], [boolean $debug = False], [boolean $forceObj = True])

boolean $setAsCurrent: if true and method $this->setAsCurrent() exists it will be called
boolean $debug
boolean $forceObj: (if true a new object will be instanciated if none is set)

getPreviewUri (line 313)

returns the preview uri

access: public

string getPreviewUri ()

getProjId (line 186)

returns the cms project id

int getProjId ([boolean $debug = False])

boolean $debug

getStateId (line 95)

returns the page state id

access: public

int getStateId ()

getTemplate (line 372)

returns the template object

access: public

CMS_PAGE_TEMPLATE &getTemplate ([boolean $debug = False])

boolean $debug

getTemplateId (line 363)

returns the template id

if col PTMP_ID is 0 the menu is asked for a template id

since: pk-07-06-07
access: public

int getTemplateId ([boolean $debug = False])

boolean $debug

getTitle (line 88)

returns the page title

access: public

string getTitle ([ $debug = False])

$debug

isCurrent (line 270)

returns if the page is the current page

access: public

boolean isCurrent ([boolean $debug = False])

boolean $debug

isExpired (line 289)

returns if the page is expired (PAG_SHOWTILL < NOW())

access: public

boolean isExpired ([boolean $debug = False])

boolean $debug

isOnline (line 279)

returns if the current page is online

access: public

boolean isOnline ([boolean $debug = False])

boolean $debug

setContentCalled (line 111)

sets contentWasCalled

getContent has been called or is to omit

access: public

void setContentCalled ([boolean $called = 'True'])

boolean $called

setDBRow (line 142)

sets a database row to the object fields

unserializes PAG_OBJECTVARS

access: public

boolean setDBRow (array $row, [boolean $asPopulated = True], [boolean $debug = False])

array $row: the row form a select * from DBMS_TABLEOBJ::myTable
boolean $asPopulated: set populateTS as if the object has been populated
boolean $debug

setDBVal (line 154)

sets all fields of an array to the objcet

access: public

boolean setDBVal (array $valArr, [boolean $debug = False])

array $valArr
boolean $debug

setId (line 81)

sets the page id

access: public

void setId (int $aId)

int $aId

setMenId (line 237)

sets the menu id

void setMenId (int $aId)

int $aId

setMyHTMLPage (line 331)

void setMyHTMLPage ( &$aHTMLPage, CMS_HTML_PAGE $aHTMLPage)

CMS_HTML_PAGE $aHTMLPage
&$aHTMLPage

setMyMenuNode (line 256)

sets the menu node object

void setMyMenuNode ( &$aNode, [boolean $debug = False], CMS_MENU_NODE $aNode)

CMS_MENU_NODE $aNode
boolean $debug
&$aNode

setMyProject (line 217)

sets the project object of the page

also sets the project id form $aProjObj

void setMyProject (CMS_PROJECT &$aProjObj, [boolean $debug = False])

boolean $debug
CMS_PROJECT &$aProjObj: aProjObj

setProjId (line 194)

sets the cms project id

void setProjId ($aId $aId)

$aId $aId: int Project ID

Documentation generated on Thu, 08 Jan 2009 17:44:25 +0100 by phpDocumentor 1.4.0a2