Stud.IP  5.4
OERModule Interface Reference
Inheritance diagram for OERModule:
CoreDocuments

Public Member Functions

 oerGetIcon ($role=Icon::ROLE_CLICKABLE)
 
 getMetadata ()
 

Static Public Member Functions

static oerModuleWantsToUseMaterial (OERMaterial $material)
 
static oerModuleIntegrateMaterialToCourse (OERMaterial $material, Course $course)
 

Member Function Documentation

◆ getMetadata()

getMetadata ( )

Implemented in CoreDocuments.

◆ oerGetIcon()

oerGetIcon (   $role = Icon::ROLE_CLICKABLE)

Returns an Icon class object with the given role.

Parameters
string$role
Returns
null|Icon

Implemented in CoreDocuments.

◆ oerModuleIntegrateMaterialToCourse()

static oerModuleIntegrateMaterialToCourse ( OERMaterial  $material,
Course  $course 
)
static

This function is triggered i a user chose to use this module as the target of the oermaterial. Now this module should put a copy of $material in its own area of the given course.

Parameters
OERMaterial$material
Course$course
Returns
void

Implemented in CoreDocuments.

◆ oerModuleWantsToUseMaterial()

static oerModuleWantsToUseMaterial ( OERMaterial  $material)
static

Determines if the StudipModule wants to handle the OERMaterial. Returns false if not.

Parameters
OERMaterial$material
Returns
false|Icon

Implemented in CoreDocuments.


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