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/local/cli/ -> shutdown.php (source)

[Source view]

CLI script shutdown helper class.

Copyright: 2019 Brendan Heywood <brendan@catalyst-au.net>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 81 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

shutdown:: (3 methods):
  script_supports_graceful_exit()
  should_gracefully_exit()
  signal_handler()


Class: shutdown  - X-Ref

CLI script shutdown helper class.

script_supports_graceful_exit()   X-Ref
Declares that this CLI script can gracefully handle signals

return: void

should_gracefully_exit()   X-Ref
Should we gracefully exit?

return: bool true if we should gracefully exit

signal_handler(int $signo)   X-Ref
Handle the signal

The first signal flags a graceful exit. If a second signal is received
then it immediately exits.

param: int $signo The signal number
return: bool true if we should exit