Docs For Class CMS_CHAPTER

Description

openCSP class CMS_CHAPTER_STATE

author: Peter Krebs <pitlinz@users.sourceforge.net>
version: $Id: CMS_CHAPTER_STATE.phpclass,v 1.2 2008/12/17 16:28:51 peterkrebs Exp $
since: pk-18.12.2008
project: Open CSP-Management
license: GNU Public License

Located in /cms/chapter/CMS_CHAPTER_STATE.phpclass (line 36)

Variable Summary

static mixed $myStateInstances

array $myDesc

int $myId

Method Summary

static array getAllStates ()

static CMS_CHAPTER_STATE &getInstance (int $aId)

CMS_CHAPTER_STATE __construct (int $aId, [array $aDesc = Null])

boolean curUserIsInGroup (int $aProjId)

int getEditGroup ()

string getIconUrl ()

void getId ()

string getName ()

boolean isOnline ()

Variables

static mixed $myStateInstances = array() (line 49)

* class vars ------------------------------------------------------

access: protected

array $myDesc = array() (line 113)

array with state description

NAME
SHOW (chapter is online by state)
ICON (path)
GROUP (members can change state)

access: protected

int $myId = 0 (line 101)

access: protected

Methods

static getAllStates (line 74)

returns an array with all state instances

access: public

array getAllStates ()

static getInstance (line 60)

returns the state instance with ID $aId

access: public

CMS_CHAPTER_STATE &getInstance (int $aId)

int $aId

Constructor __construct (line 128)

constructor

if no description array is passed in $aDesc the description is taken from OCSP_CONF::getInstance('OCSP_CMS')

access: protected

CMS_CHAPTER_STATE __construct (int $aId, [array $aDesc = Null])

int $aId
array $aDesc

curUserIsInGroup (line 205)

returns if the current user is in the state group

access: public

boolean curUserIsInGroup (int $aProjId)

int $aProjId

getEditGroup (line 189)

returns the group which can edit the chapter

access: public

int getEditGroup ()

getIconUrl (line 169)

returns the icon URL

access: public

string getIconUrl ()

getId (line 149)

returns the state id

access: public

void getId ()

getName (line 159)

returns the state name

access: public

string getName ()

isOnline (line 179)

returns if the state is online

access: public

boolean isOnline ()