Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/mod/scorm/ -> renderer.php (source)

[Source view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402]

Defines the renderer for the scorm module.

Author: Dan Marsden <dan@danmarsden.com>
Copyright: 2013 Dan Marsden
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 231 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

mod_scorm_renderer:: (5 methods):
  view_user_heading()
  render_mod_scorm_attempt_bar()
  report_actionbar()
  user_report_actionbar()
  generate_exitbar()

mod_scorm_attempt_bar:: (2 methods):
  __construct()
  prepare()


Class: mod_scorm_renderer  - X-Ref

The renderer for the scorm module.

view_user_heading($user, $course, $baseurl, $attempt, $attemptids)   X-Ref
No description

render_mod_scorm_attempt_bar(mod_scorm_attempt_bar $attemptbar)   X-Ref
scorm attempt bar renderer

param: mod_scorm_attempt_bar $attemptbar
return: string

report_actionbar(\mod_scorm\output\actionbar $actionbar)   X-Ref
Rendered HTML for the report action is provided.

param: \mod_scorm\output\actionbar $actionbar actionbar object.
return: bool|string rendered HTML for the report action.

user_report_actionbar(\mod_scorm\output\userreportsactionbar $userreportsactionbar)   X-Ref
Rendered HTML for the user report action is provided

param: \mod_scorm\output\userreportsactionbar $userreportsactionbar userreportsactionbar object
return: string rendered HTML for the user report action.

generate_exitbar(string $url)   X-Ref
Generate the SCORM's "Exit activity" button

param: string $url The url to be hooked up to the exit button
return: string

Class: mod_scorm_attempt_bar  - X-Ref

Component representing a SCORM attempts bar.

__construct($attemptids, $attempt, $baseurl, $pagevar = 'page')   X-Ref
Constructor mod_scorm_attempt_bar with only the required params.

param: array $attemptids an array of attempts the user has made
param: int $attempt The attempt you are currently viewing
param: string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
param: string $pagevar name of page parameter that holds the attempt number

prepare(renderer_base $output, moodle_page $page, $target)   X-Ref
Prepares the scorm attempt bar for output.

This method validates the arguments set up for the scorm attempt bar and then
produces fragments of HTML to assist display later on.

param: renderer_base $output
param: moodle_page $page
param: string $target