CMSkey Class Reference

Content Management System class. More...

List of all members.

Public Member Functions
	__construct ()
	Constructor.
	getPageTitle ()
	Get the title of the current page.
	getTopBar ()
	Get the top (menu) bar if visible.
	getHTML ()
	Get current XHTML-rendered content page.
	doAction ($action)
	Do an action.
Static Public Member Functions
static	postOrGet ($varname)
	Return POST or at least GET var value.
static	getQueryString ($excluded="")
	Get forged query string.
Public Attributes
const	SYSMSG_NOTIFY = 0
	System message levels.
const	SYSMSG_WARNING = 1
const	SYSMSG_ERROR = 2
Private Member Functions
	getLoginStatus ()
	Get login status.
	getSearchForm ()
	Get search form.
	getHeader ()
	Get the page header.
	getFooter ()
	Get the page footer.
	getSideContent ($side)
	Get side content.
	getRightContent ()
	Get right content.
	getLeftContent ()
	Get left content.
	getMiddleContent ()
	Get the middle content.
	getMainContent ()
	Get the main content.
Private Attributes
	$lp = array()
	layout parameters
	$title = NULL
	page title
	$layout = array()
	page layout description

---

Detailed Description

Content Management System class.

Definition at line 36 of file cmskey.php.

---

Constructor & Destructor Documentation

CMSkey::__construct

(

)

Constructor.

Definition at line 51 of file cmskey.php.

References $cfg.

---

Member Function Documentation

static CMSkey::postOrGet

(

$

varname

)

[static]

Return POST or at least GET var value.

Parameters:

varname

(string) POST/GET variable name

Returns:

(mixed) POST/GET variable value

Definition at line 89 of file cmskey.php.

static CMSkey::getQueryString

(

$

excluded = ""

)

[static]

Get forged query string.

Build a new query string excluding specified parameters.

Parameters:

excluded

(string) list of excluded parameters (all in one string, separated by '|')

Returns:

(string) forged query string

Definition at line 101 of file cmskey.php.

Referenced by Lang::getLanguageMenu().

CMSkey::getPageTitle

(

)

Get the title of the current page.

Returns:

(string) the title of the current page

Definition at line 124 of file cmskey.php.

References $cfg.

CMSkey::getLoginStatus

(

)

[private]

Get login status.

Returns:

(string) string login status

Definition at line 139 of file cmskey.php.

References $cfg, and $session.

Referenced by getHeader().

CMSkey::getSearchForm

(

)

[private]

Get search form.

Returns:

(string) search form

Definition at line 161 of file cmskey.php.

References $cfg.

Referenced by getHeader().

CMSkey::getHeader

(

)

[private]

Get the page header.

Returns:

(string) page header

Definition at line 193 of file cmskey.php.

References $cfg, $lang, getLoginStatus(), and getSearchForm().

Referenced by getHTML().

CMSkey::getTopBar

(

)

Get the top (menu) bar if visible.

Returns:

(string) top bar

Definition at line 217 of file cmskey.php.

References $cfg.

Referenced by getHTML().

CMSkey::getFooter

(

)

[private]

Get the page footer.

Returns:

(string) page footer

Definition at line 242 of file cmskey.php.

References $cfg, and Config::CMSKEY_VERSION.

Referenced by getHTML().

CMSkey::getSideContent

(

$

side

)

[private]

Get side content.

Parameters:

side

['L'|'R']

Returns:

(string) side content

Definition at line 262 of file cmskey.php.

Referenced by getLeftContent(), and getRightContent().

CMSkey::getRightContent

(

)

[private]

Get right content.

Returns:

(string) right content

Definition at line 297 of file cmskey.php.

References getSideContent().

Referenced by getMainContent().

CMSkey::getLeftContent

(

)

[private]

Get left content.

Returns:

(string) left content

Definition at line 306 of file cmskey.php.

References getSideContent().

Referenced by getMainContent().

CMSkey::getMiddleContent

(

)

[private]

Get the middle content.

Returns:

(string) middle content

Definition at line 315 of file cmskey.php.

Referenced by getMainContent().

CMSkey::getMainContent

(

)

[private]

Get the main content.

Returns:

(string) main content

Definition at line 360 of file cmskey.php.

References getLeftContent(), getMiddleContent(), and getRightContent().

Referenced by getHTML().

CMSkey::getHTML

(

)

Get current XHTML-rendered content page.

Returns:

(string) current XHTML-rendered content page

Definition at line 403 of file cmskey.php.

References getFooter(), getHeader(), getMainContent(), and getTopBar().

CMSkey::doAction

(

$

action

)

Do an action.

Do a specified action but don't render the page.

Parameters:

action

(string) action to do

Definition at line 424 of file cmskey.php.

References $action.

---

Member Data Documentation

const CMSkey::SYSMSG_NOTIFY = 0

System message levels.

Definition at line 40 of file cmskey.php.

const CMSkey::SYSMSG_WARNING = 1

Definition at line 41 of file cmskey.php.

const CMSkey::SYSMSG_ERROR = 2

Definition at line 42 of file cmskey.php.

CMSkey::$lp = array() [private]

layout parameters

Definition at line 44 of file cmskey.php.

CMSkey::$title = NULL [private]

page title

Definition at line 45 of file cmskey.php.

CMSkey::$layout = array() [private]

page layout description

Definition at line 46 of file cmskey.php.

---

The documentation for this class was generated from the following file:

• cmskey.php

---