Moodle APIs 4.1
Moodle 4.1.9+ (Build: 20240402)
Functions
clilib.php File Reference

Command line utility functions and classes. More...

Functions

 cli_error ($text, $errorcode=1)
 Write to standard error output and exit with the given code.
 
 cli_get_params (array $longoptions, array $shortmapping=null)
 Returns cli script parameters.
 
 cli_heading ($string, $return=false)
 Print or return section heading string.
 
 cli_input ($prompt, $default='', array $options=null, $casesensitiveoptions=false)
 Get input from user.
 
 cli_logo ($padding=2, $return=false)
 Print an ASCII version of the Moodle logo.
 
 cli_problem ($text)
 Write error notification.
 
 cli_separator ($return=false)
 Print or return section separator string.
 
 cli_set_process_title_suffix (string $suffix)
 This sets the cli process title suffix.
 
 cli_write ($text, $stream=STDOUT)
 Write a text to the given stream.
 
 cli_writeln ($text, $stream=STDOUT)
 Write a text followed by an end of line symbol to the given stream.
 

Detailed Description

Command line utility functions and classes.

@subpackage cli

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later