[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/classes/event/ -> course_completed.php (summary)

Course completed event.

Copyright: 2013 Rajesh Taneja <[email protected]>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 137 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

course_completed:: (8 methods):
  create_from_completion()
  init()
  get_name()
  get_description()
  get_url()
  get_legacy_eventname()
  get_legacy_eventdata()
  validate_data()


Class: course_completed  - X-Ref

Course completed event class.

create_from_completion(\stdClass $completion)   X-Ref
Create event from course_completion record.

param: \stdClass $completion
return: course_completed

init()   X-Ref
Initialise required event data properties.


get_name()   X-Ref
Returns localised event name.

return: string

get_description()   X-Ref
Returns non-localised event description with id's for admin use only.

return: string

get_url()   X-Ref
Returns relevant URL.

return: \moodle_url

get_legacy_eventname()   X-Ref
Return name of the legacy event, which is replaced by this event.

return: string legacy event name

get_legacy_eventdata()   X-Ref
Return course_completed legacy event data.

return: \stdClass completion data.

validate_data()   X-Ref
Custom validation.

return: void



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1