Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/enrol/imsenterprise/ -> locallib.php (source)

[Source view]

IMS Enterprise enrol plugin implementation.

Copyright: 2010 Eugene Venter
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 170 lines (5 kb)
Included or required: 2 times
Referenced: 2 times
Includes or requires: 0 files

Defines 2 classes

imsenterprise_roles:: (3 methods):
  __construct()
  get_imsroles()
  determine_default_rolemapping()

imsenterprise_courses:: (4 methods):
  __construct()
  get_imsnames()
  get_courseattrs()
  determine_default_coursemapping()


Class: imsenterprise_roles  - X-Ref

Class for dealing with role mappings in IMS Enterprise.

__construct()   X-Ref
Constructor.


get_imsroles()   X-Ref
Returns the mapped roles

return: array of IMS roles indexed by IMS code.

determine_default_rolemapping($imscode)   X-Ref
This function is only used when first setting up the plugin, to
decide which role assignments to recommend by default.
For example, IMS role '01' is 'Learner', so may map to 'student' in Moodle.

param: string $imscode

Class: imsenterprise_courses  - X-Ref

Mapping between Moodle course attributes and IMS enterprise group description tags

__construct()   X-Ref
Loads default


get_imsnames($courseattr)   X-Ref
Returns the assignable values for the course attribute

param: string $courseattr The course attribute (shortname, fullname...)
return: array Array of assignable values

get_courseattrs()   X-Ref
courseattrs getter

return: array

determine_default_coursemapping($courseattr)   X-Ref
This function is only used when first setting up the plugin, to
decide which name assignments to recommend by default.

param: string $courseattr
return: string