Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
CoreDocuments Class Reference
Inheritance diagram for CoreDocuments:
CorePlugin StudipModule OERModule

Public Member Functions

 oerGetIcon ($role=Icon::ROLE_CLICKABLE)
 
 getIconNavigation ($course_id, $last_visit, $user_id)
 
 getTabNavigation ($course_id)
 
 getMetadata ()
 
 getInfoTemplate ($course_id)
 
- Public Member Functions inherited from CorePlugin
 __construct ()
 
 getPluginId ()
 
 isEnabled ()
 
 getPluginName ()
 
 getPluginURL ()
 
 getPluginVersion ()
 
 isCorePlugin ()
 
 isActivated ($context=null)
 
 isActivatableForContext (Range $context)
 

Static Public Member Functions

static oerModuleWantsToUseMaterial (OERMaterial $material)
 
static oerModuleIntegrateMaterialToCourse (OERMaterial $material, Course $course)
 
- Static Public Member Functions inherited from CorePlugin
static onEnable ($plugin_id)
 
static onDisable ($plugin_id)
 
static onActivation ($plugin_id, $range_id)
 
static onDeactivation ($plugin_id, $range_id)
 
static checkActivation ($range_id)
 

Additional Inherited Members

- Protected Attributes inherited from CorePlugin
 $plugin_info
 

Member Function Documentation

getIconNavigation (   $course_id,
  $last_visit,
  $user_id 
)

{Return a navigation object representing this plugin in the course overview table or return NULL if you want to display no icon for this plugin (or course). The navigation object's title will not be shown, only the image (and its associated attributes like 'title') and the URL are actually used.By convention, new or changed plugin content is indicated by a different icon and a corresponding tooltip.

Parameters
string$course_idcourse or institute range id
int$last_visittime of user's last visit
string$user_idthe user to get the navigation for
Returns
object navigation item to render or NULL
}

Implements StudipModule.

getInfoTemplate (   $course_id)

Return a template (an instance of the Flexi_Template class) to be rendered on the course summary page. Return NULL to render nothing for this plugin.

The template will automatically get a standard layout, which can be configured via attributes set on the template:

title title to display, defaults to plugin name icon_url icon for this plugin (if any) admin_url admin link for this plugin (if any) admin_title title for admin link (default: Administration)

Returns
object template object to render or NULL

Implements StudipModule.

getMetadata ( )

{}

Implements OERModule.

getTabNavigation (   $course_id)

{Return a navigation object representing this plugin in the course overview table or return NULL if you want to display no icon for this plugin (or course). The navigation object's title will not be shown, only the image (and its associated attributes like 'title') and the URL are actually used.By convention, new or changed plugin content is indicated by a different icon and a corresponding tooltip.

Parameters
string$course_idcourse or institute range id
Returns
array navigation item to render or NULL
}

Implements StudipModule.

oerGetIcon (   $role = Icon::ROLE_CLICKABLE)

Returns an Icon class object with the given role.

Parameters
string$role
Returns
null|Icon

Implements OERModule.

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
array|FileType

Implements OERModule.

static oerModuleWantsToUseMaterial ( OERMaterial  $material)
static

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

Parameters
OERMaterial$material
Returns
false|Icon

Implements OERModule.


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