Claroline Class Reference

Public Member Functions
	pushModuleLabel ($label)
	popModuleLabel ()
	currentModuleLabel ()
	setDisplayType ($type=self::PAGE)
Static Public Member Functions
static	getInstance ()
static	getDisplay ()
static	initDisplay ($displayType=self::PAGE)
static	log ($type, $data)
static	getDatabase ()
static	initMainDatabase ()
static	ajaxServiceBroker ()
Data Fields
const	PAGE = 'CL_PAGE'
const	FRAMESET = 'CL_FRAMESET'
const	POPUP = 'CL_POPUP'
const	FRAME = 'CL_FRAME'
	$eventManager
	$notification
	$notifier
	$display
	$logger
Protected Attributes
	$moduleLabelStack
Static Protected Attributes
static	$db = false
static	$database = false
static	$_ajaxServiceBroker = false
Private Member Functions
	__construct ()
Static Private Attributes
static	$instance = false

---

Detailed Description

Main Claroline class containing references to Claroline kernel objects This class is a Singleton

Definition at line 50 of file claroline.lib.php.

---

Constructor & Destructor Documentation

__construct

(

)

[private]

Definition at line 81 of file claroline.lib.php.

---

Member Function Documentation

static ajaxServiceBroker

(

)

[static]

Get kernel Ajax Service Broker instance

Returns:

Ajax_Remote_Service_Broker

Since:

Claroline 1.9.5

Definition at line 293 of file claroline.lib.php.

currentModuleLabel

(

)

Get the label of the current module

Returns:

string or false

Definition at line 129 of file claroline.lib.php.

static getDatabase

(

)

[static]

Get the current database connection object

Returns:

Claroline_Database_Connection

Definition at line 230 of file claroline.lib.php.

static getDisplay

(

)

[static]

Get the current display object

Returns:

Display which can be a ClaroPage or ClaroFramesetPage according to the display type

Definition at line 198 of file claroline.lib.php.

static getInstance

(

)

[static]

Returns the singleton instance of the Claroline object

Returns:

Claroline singleton instance

Definition at line 183 of file claroline.lib.php.

static initDisplay

(

$

displayType = self::PAGE

)

[static]

Helper to initialize the display

Parameters:

string

$displayType

Definition at line 207 of file claroline.lib.php.

static initMainDatabase

(

)

[static]

Definition at line 242 of file claroline.lib.php.

static log	(	$	type,
		$	data
	)			[static]

Helper to log a message

Parameters:

	string	$type
	string	$data

Definition at line 217 of file claroline.lib.php.

popModuleLabel

(

)

Remove the modulke label at the top of the module stack

Definition at line 120 of file claroline.lib.php.

pushModuleLabel

(

$

label

)

Add a label at the top of the module stack

Parameters:

string

$label

Definition at line 112 of file claroline.lib.php.

setDisplayType

(

$

type = self::PAGE

)

Set the type of display to use

Parameters:

string

type, display type could be Claroline::PAGE a standard page with header, banner, body and footer Claroline::FRAMESET a frameset with header and frames Claroline::POPUP a popup-embedded page Claroline::FRAME a frame-embedded page default value : Claroline::PAGE

Definition at line 150 of file claroline.lib.php.

---

Field Documentation

$_ajaxServiceBroker = false [static, protected]

Definition at line 286 of file claroline.lib.php.

$database = false [static, protected]

Definition at line 224 of file claroline.lib.php.

$db = false [static, protected]

Definition at line 222 of file claroline.lib.php.

$display

Definition at line 72 of file claroline.lib.php.

$eventManager

Definition at line 62 of file claroline.lib.php.

$instance = false [static, private]

Definition at line 177 of file claroline.lib.php.

$logger

Definition at line 76 of file claroline.lib.php.

$moduleLabelStack [protected]

Definition at line 78 of file claroline.lib.php.

$notification

Definition at line 66 of file claroline.lib.php.

$notifier

Definition at line 70 of file claroline.lib.php.

const FRAME = 'CL_FRAME'

Definition at line 56 of file claroline.lib.php.

const FRAMESET = 'CL_FRAMESET'

Definition at line 54 of file claroline.lib.php.

const PAGE = 'CL_PAGE'

Definition at line 53 of file claroline.lib.php.

const POPUP = 'CL_POPUP'

Definition at line 55 of file claroline.lib.php.

---

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

• claroline/claroline/inc/lib/core/claroline.lib.php