TrackingRendererRegistry Class Reference

Public Member Functions

 __construct ($courseId=null)
 registerCourse ($className)
 registerUser ($className, $context=self::COURSE)
 loadAll ()
 getCourseRendererList ()
 getUserRendererList ($context=self::COURSE)
 getUserPlatformRendererList ()

Static Public Member Functions

static getInstance ($courseId)

Data Fields

const PLATFORM = 'platform'
const COURSE = 'course'

Private Member Functions

 loadDefaultRenderer ()
 loadModuleRenderer ()

Private Attributes

 $courseId
 $courseRendererList
 $userRendererList
 $userPlatformRendererList

Static Private Attributes

static $instance = false

Detailed Description

Singleton class used to load all available tracking renderer connector and to keep the list of available tracking rendering classes found in connectors

Definition at line 24 of file trackingRendererRegistry.class.php.


Constructor & Destructor Documentation

__construct ( courseId = null  ) 

Construtor

Definition at line 40 of file trackingRendererRegistry.class.php.


Member Function Documentation

getCourseRendererList (  ) 

Returns array of available course tracking renderers

Returns:
array list of classnames

Definition at line 145 of file trackingRendererRegistry.class.php.

static getInstance ( courseId  )  [static]

singleton method

Returns:
instance

Definition at line 179 of file trackingRendererRegistry.class.php.

getUserPlatformRendererList (  ) 

Returns array of available user tracking renderers

Returns:
array list of class names

Definition at line 169 of file trackingRendererRegistry.class.php.

getUserRendererList ( context = self::COURSE  ) 

Returns array of available user tracking renderers

Returns:
array list of class names

Definition at line 155 of file trackingRendererRegistry.class.php.

loadAll (  ) 

Load all tracking renderers

Parameters:
string $cidReq

Definition at line 79 of file trackingRendererRegistry.class.php.

loadDefaultRenderer (  )  [private]

Load the default tracking renderers. These are the renderers not related to any module such as course access and tool access

Definition at line 91 of file trackingRendererRegistry.class.php.

loadModuleRenderer (  )  [private]

Search in all activated modules

Parameters:
string $cidReq

Definition at line 111 of file trackingRendererRegistry.class.php.

registerCourse ( className  ) 

Add $className to the list of course tracking renderers

Parameters:
string $className

Definition at line 54 of file trackingRendererRegistry.class.php.

registerUser ( className,
context = self::COURSE 
)

Add $className to the list of user tracking renderers

Parameters:
string $className

Definition at line 64 of file trackingRendererRegistry.class.php.


Field Documentation

$courseId [private]

Definition at line 31 of file trackingRendererRegistry.class.php.

$courseRendererList [private]

Definition at line 32 of file trackingRendererRegistry.class.php.

$instance = false [static, private]

Definition at line 29 of file trackingRendererRegistry.class.php.

$userPlatformRendererList [private]

Definition at line 34 of file trackingRendererRegistry.class.php.

$userRendererList [private]

Definition at line 33 of file trackingRendererRegistry.class.php.

const COURSE = 'course'

Definition at line 27 of file trackingRendererRegistry.class.php.

const PLATFORM = 'platform'

Definition at line 26 of file trackingRendererRegistry.class.php.


The documentation for this class was generated from the following file:
Generated on Tue Jun 8 12:28:40 2010 for Claroline API by  doxygen 1.6.3