[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/enrol/imsenterprise/ -> enrol.php (summary)

(no description)

File Size: 886 lines (42 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

enrolment_plugin_imsenterprise:: (15 methods):
  determine_default_rolemapping()
  config_form()
  process_config()
  get_access_icons()
  cron()
  full_tag_found_in_cache()
  remove_tag_from_cache()
  get_recstatus()
  process_group_tag()
  process_person_tag()
  process_membership_tag()
  process_properties_tag()
  log_line()
  decode_timeframe()
  load_role_mappings()


Class: enrolment_plugin_imsenterprise  - X-Ref


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.


config_form($frm)   X-Ref
No description

process_config($config)   X-Ref
No description

get_access_icons($course)   X-Ref
No description

cron()   X-Ref
Read in an IMS Enterprise file.
Originally designed to handle v1.1 files but should be able to handle
earlier types as well, I believe.


full_tag_found_in_cache($tagname, $latestline)   X-Ref
Check if a complete tag is found in the cached data, which usually happens
when the end of the tag has only just been loaded into the cache.
Returns either false, or the contents of the tag (including start and end).

param: string $tagname Name of tag to look for
param: string $latestline The very last line in the cache (used for speeding up the match)

remove_tag_from_cache($tagname)   X-Ref
Remove complete tag from the cached data (including all its contents) - so
that the cache doesn't grow to unmanageable size

param: string $tagname Name of tag to look for

get_recstatus($tagdata, $tagname)   X-Ref
Very simple convenience function to return the "recstatus" found in person/group/role tags.
1=Add, 2=Update, 3=Delete, as specified by IMS, and we also use 0 to indicate "unspecified".

param: string $tagdata the tag XML data
param: string $tagname the name of the tag we're interested in

process_group_tag($tagcontents)   X-Ref
Process the group tag. This defines a Moodle course.

param: string $tagconents The raw contents of the XML element

process_person_tag($tagcontents)   X-Ref
Process the person tag. This defines a Moodle user.

param: string $tagconents The raw contents of the XML element

process_membership_tag($tagcontents)   X-Ref
Process the membership tag. This defines whether the specified Moodle users
should be added/removed as teachers/students.

param: string $tagconents The raw contents of the XML element

process_properties_tag($tagcontents)   X-Ref
Process the properties tag. The only data from this element
that is relevant is whether a <target> is specified.

param: string $tagconents The raw contents of the XML element

log_line($string)   X-Ref
Store logging information. This does two things: uses the {@link mtrace()}
function to print info to screen/STDOUT, and also writes log to a text file
if a path has been specified.

param: string $string Text to write (newline will be added automatically)

decode_timeframe($string)   X-Ref
Process the INNER contents of a <timeframe> tag, to return beginning/ending dates.


load_role_mappings()   X-Ref
Load the role mappings (from the config), so we can easily refer to
how an IMS-E role corresponds to a Moodle role




Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7