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.
/lib/classes/progress/ -> display_if_slow.php (source)

[Source view]

(no description)

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

Defines 1 class

display_if_slow:: (4 methods):
  __construct()
  start_html()
  update_progress()
  end_html()


Class: display_if_slow  - X-Ref

Progress handler that uses a standard Moodle progress bar to display
progress. Same as \core\progress\display, but the bar does not
appear until a certain time has elapsed, and disappears automatically
after it finishes.

The bar can be re-used, i.e. if you end all sections it will disappear,
but if you start all sections, a new bar will be output.

__construct($heading = '', $delay = self::DEFAULT_DISPLAY_DELAY)   X-Ref
Constructs the progress reporter. This will not output HTML just yet,
until the required delay time expires.

param: string $heading Text to display above bar (if it appears); '' for none (default)
param: int $delay Delay time (default 5 seconds)

start_html()   X-Ref
Starts displaying the progress bar, with optional heading and a special
div so it can be hidden later.


update_progress()   X-Ref
When progress is updated, after a certain time, starts actually displaying
the progress bar.


end_html()   X-Ref
Finishes parent display then closes div and hides it.