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.

(no description)

File Size: 156 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

display:: (5 methods):
  __construct()
  set_display_names()
  start_html()
  end_html()
  update_progress()


Class: display  - X-Ref

Progress handler that uses a standard Moodle progress bar to display
progress. The Moodle progress bar cannot show indeterminate progress,
so we do extra output in addition to the bar.

__construct($startnow = true)   X-Ref
Constructs the progress reporter. This will output HTML code for the
progress bar, and an indeterminate wibbler below it.

param: bool $startnow If true, outputs HTML immediately.

set_display_names($displaynames = true)   X-Ref
By default, the progress section names do not display because
these will probably be untranslated and incomprehensible. To make them
display, call this method.

param: bool $displaynames True to display names

start_html()   X-Ref
Starts to output progress.

Called in constructor and in update_progress if required.


end_html()   X-Ref
Finishes output. (Progress can begin again later if there are more
calls to update_progress.)

Automatically called from update_progress when progress finishes.

update_progress()   X-Ref
When progress is updated, updates the bar.