diff --git a/classes/local/cli/clibase.php b/classes/local/cli/clibase.php index dc96578..a22c096 100644 --- a/classes/local/cli/clibase.php +++ b/classes/local/cli/clibase.php @@ -147,5 +147,6 @@ abstract class clibase { $long = '--'.$long; printf(" %-4s %-20s %s\n", $short, $long, $text); } + printf("\n%s\n\n", get_string('cli'.$cliname.'examples', 'auth_outage')); } } diff --git a/classes/local/cli/create.php b/classes/local/cli/create.php index bdd04f5..754bdf9 100644 --- a/classes/local/cli/create.php +++ b/classes/local/cli/create.php @@ -200,7 +200,7 @@ class create extends clibase { private function clone_defaults() { $id = $this->options['clone']; if (!is_number($id) || ($id <= 0)) { - throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => 'clone']), + throw new cli_exception(get_string('clierrorinvalidvaluenotid', 'auth_outage', ['param' => 'clone']), cli_exception::ERROR_PARAMETER_INVALID); } @@ -245,12 +245,12 @@ class create extends clibase { */ private function merge_options_check_parameters_int_nonnegative($option, $param) { if (!is_number($option)) { - throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]), + throw new cli_exception(get_string('clierrorinvalidvaluenotnumber', 'auth_outage', ['param' => $param]), cli_exception::ERROR_PARAMETER_INVALID); } $option = (int)$option; if ($option < 0) { - throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]), + throw new cli_exception(get_string('clierrorinvalidvaluenegativenumber', 'auth_outage', ['param' => $param]), cli_exception::ERROR_PARAMETER_INVALID); } return $option; @@ -265,12 +265,12 @@ class create extends clibase { */ private function merge_options_check_parameters_string_nonempty($option, $param) { if (!is_string($option)) { - throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]), + throw new cli_exception(get_string('clierrorinvalidvaluenotstring', 'auth_outage', ['param' => $param]), cli_exception::ERROR_PARAMETER_INVALID); } $option = trim($option); if (strlen($option) == 0) { - throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]), + throw new cli_exception(get_string('clierrorinvalidvalueemptystring', 'auth_outage', ['param' => $param]), cli_exception::ERROR_PARAMETER_INVALID); } return $option; @@ -298,7 +298,7 @@ class create extends clibase { } } - throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]), + throw new cli_exception(get_string('clierrorinvalidvaluenotbool', 'auth_outage', ['param' => $param]), cli_exception::ERROR_PARAMETER_INVALID); } } diff --git a/lang/en/auth_outage.php b/lang/en/auth_outage.php index 289c629..98fc5d1 100644 --- a/lang/en/auth_outage.php +++ b/lang/en/auth_outage.php @@ -27,6 +27,7 @@ $string['auth_outagedescription'] = 'Auxiliary plugin that warns users about a f $string['autostart'] = 'Auto start maintenance mode.'; $string['autostart_help'] = 'If selected, when the outage starts it will automatically turn on Moodle maintenance mode.'; $string['clicreatehelp'] = 'Creates a new outage.'; +$string['clicreateexamples'] = "Create an outage starting in 10 seconds\n\n> php create.php -s=10"; $string['clicreateparamautostart'] = 'must be Y or N, sets if the outage automatically triggers maintenance mode.'; $string['clicreateparamblock'] = 'blocks until outage starts.'; $string['clicreateparamclone'] = 'clone another outage except for the start time.'; @@ -38,6 +39,7 @@ $string['clicreateparamstart'] = 'in how many seconds should this outage start o $string['clicreateparamtitle'] = 'the title of the outage.'; $string['clicreateparamwarn'] = 'how many seconds before it starts to display a warning.'; $string['clifinishhelp'] = 'Finishes an ongoing outage.'; +$string['clifinishexamples'] = ''; $string['clifinishnotongoing'] = 'Outage is not ongoing.'; $string['clifinishparamhelp'] = 'shows parameters help.'; $string['clifinishparamactive'] = 'finishes the currently active outage.'; @@ -45,6 +47,7 @@ $string['clifinishparamoutageid'] = 'the id of the outage to finish.'; $string['cliinmaintenancemode'] = 'Moodle maintenance mode is on. Use "php admin/cli/maintenance.php --disable" to disable it before finishing the outage.'; $string['cliwaitforiterroridxoractive'] = 'You must use --outageid=# or --active parameter but not both.'; $string['cliwaitforithelp'] = 'Waits until an outage starts.'; +$string['cliwaitforitexamples'] = ''; $string['cliwaitforitoutagestarted'] = 'Outage started!'; $string['cliwaitforitoutagestartingin'] = 'Outage starting in {$a->countdown}.'; $string['cliwaitforitparamactive'] = 'wait for the currently active outage.'; @@ -53,6 +56,12 @@ $string['cliwaitforitparamoutageid'] = 'the id of the outage to wait until it st $string['cliwaitforitparamsleep'] = 'maximum amount of seconds before status output.'; $string['cliwaitforitparamverbose'] = 'enable verbose mode.'; $string['clierrorinvalidvalue'] = 'Invalid value for parameter: {$a->param}'; +$string['clierrorinvalidvaluenotid'] = 'Param --{$a->param} must be an id number'; +$string['clierrorinvalidvaluenotbool'] = 'Param --{$a->param} must be set to either Y or N'; +$string['clierrorinvalidvaluenotnumber'] = 'Param --{$a->param} must be a number'; +$string['clierrorinvalidvaluenegativenumber'] = 'Param --{$a->param} must be a positive number'; +$string['clierrorinvalidvaluenotstring'] = 'Param --{$a->param} must be a string'; +$string['clierrorinvalidvalueemptystring'] = 'Param --{$a->param} must not be an empty string'; $string['clierrormissingparamaters'] = 'You must specify the start time, use --help for more information.'; $string['clierroroutagechanged'] = 'Outage was changed while waiting.'; $string['clierroroutageended'] = 'Outage has already ended.';