feat!: standardize language strings (close #29)

Almost all string IDs use namespacing/scoping via colons.
Currently the prefixes `error:`, `event:`, `metric:`, and `settings:` exist.
The remaining ones are forced to follow a certain pattern by Moodle.
Word separation via underscores is used consistently (wherever possible).
Metric descriptions match metric names exactly and have a `metric:` prefix and `_description` suffix.
Metric config options also have the `metric:` prefix, followed by the config class name and another colon, followed by the actual option name.

Co-authored-by: Sebastian Rupp <sr@artcodix.com>
Co-authored-by: Marion Hilgers <mh@artcodix.com>

Author: 3 people

classes/event/metric_config_updated.php

@@ -51,7 +51,7 @@ class metric_config_updated extends metric_event {
      */
     #[\Override]
     public static function get_name(): lang_string {
-        return new lang_string('metricconfigupdated', 'tool_monitoring');
+        return new lang_string('event:metric_config_updated', 'tool_monitoring');
     }
 
     /**

classes/form/config.php

@@ -63,27 +63,27 @@ protected function definition(): void {
         $this->_form->setType('metric', PARAM_ALPHAEXT);
         $this->add_static_field(
             name: 'component',
-            label: new lang_string('component', 'tool_monitoring'),
+            label: new lang_string('settings:component', 'tool_monitoring'),
             value: $this->metric->component,
         );
         $this->add_static_field(
             name: 'name',
-            label: new lang_string('name', 'tool_monitoring'),
+            label: new lang_string('settings:name', 'tool_monitoring'),
             value: $this->metric->name,
         );
         $this->add_static_field(
             name: 'type',
-            label: new lang_string('type', 'tool_monitoring'),
+            label: new lang_string('settings:type', 'tool_monitoring'),
             value: $this->metric->type->value,
         );
         $this->add_static_field(
             name: 'description',
-            label: new lang_string('description', 'tool_monitoring'),
+            label: new lang_string('settings:description', 'tool_monitoring'),
             value: $this->metric->description,
         );
         $this->add_advanced_checkbox_field(
             name: 'enabled',
-            label: new lang_string('metricenabled', 'tool_monitoring'),
+            label: new lang_string('settings:metric_enabled', 'tool_monitoring'),
         );
         $this->add_tags_field(
             itemtype: 'metrics',

classes/local/metrics/courses.php

@@ -59,7 +59,7 @@ public static function get_type(): metric_type {
      * {@inheritDoc}
      */
     public static function get_description(): lang_string {
-        return new lang_string('courses_description', 'tool_monitoring');
+        return new lang_string('metric:courses_description', 'tool_monitoring');
     }
 
     /**

classes/local/metrics/overdue_tasks.php

@@ -56,7 +56,7 @@ class overdue_tasks extends metric {
      * {@inheritDoc}
      */
     public static function get_description(): lang_string {
-        return new lang_string('overdue_tasks_description', 'tool_monitoring');
+        return new lang_string('metric:overdue_tasks_description', 'tool_monitoring');
     }
 
     /**

classes/local/metrics/quiz_attempts_in_progress.php

@@ -63,7 +63,7 @@ public static function get_type(): metric_type {
      * {@inheritDoc}
      */
     public static function get_description(): lang_string {
-        return new lang_string('quiz_attempts_in_progress_description', 'tool_monitoring');
+        return new lang_string('metric:quiz_attempts_in_progress_description', 'tool_monitoring');
     }
 
     /**

classes/local/metrics/user_accounts.php

@@ -60,7 +60,7 @@ public static function get_type(): metric_type {
      * {@inheritDoc}
      */
     public static function get_description(): lang_string {
-        return new lang_string('user_accounts_description', 'tool_monitoring');
+        return new lang_string('metric:user_accounts_description', 'tool_monitoring');
     }
 
     /**

classes/local/metrics/users_online.php

@@ -60,7 +60,7 @@ public static function get_type(): metric_type {
      * {@inheritDoc}
      */
     public static function get_description(): lang_string {
-        return new lang_string('users_online_description', 'tool_monitoring');
+        return new lang_string('metric:users_online_description', 'tool_monitoring');
     }
 
     /**

classes/local/metrics/users_online_config.php

@@ -137,9 +137,9 @@ public function to_form_data(): array {
 
     #[\Override]
     public static function extend_form_definition(config_form $configform, MoodleQuickForm $mform): void {
-        $mform->addElement('text', 'timewindows', new lang_string('users_online_time_windows', 'tool_monitoring'));
+        $mform->addElement('text', 'timewindows', new lang_string('metric:users_online_config:timewindows', 'tool_monitoring'));
         $mform->setType('timewindows', PARAM_TEXT);
-        $mform->addHelpButton('timewindows', 'users_online_time_windows', 'tool_monitoring');
+        $mform->addHelpButton('timewindows', 'metric:users_online_config:timewindows', 'tool_monitoring');
         $mform->addRule('timewindows', null, 'required', null, 'client');
     }
 

configure.php

@@ -45,8 +45,8 @@
 $qualifiedname = required_param('metric', PARAM_ALPHAEXT);
 $PAGE->set_url('/admin/tool/monitoring/configure.php', ['metric' => $qualifiedname]);
 $PAGE->set_context($context);
-$PAGE->set_title(get_string('monitoring_metrics', 'tool_monitoring'));
-$PAGE->set_heading(get_string('monitoring_metrics', 'tool_monitoring'));
+$PAGE->set_title(get_string('settings:monitoring_metrics', 'tool_monitoring'));
+$PAGE->set_heading(get_string('settings:monitoring_metrics', 'tool_monitoring'));
 $PAGE->add_body_class('limitedwidth');
 
 $manager = new metrics_manager();

exporter/prometheus/lang/en/monitoringexporter_prometheus.php

@@ -28,5 +28,5 @@
  */
 
 $string['pluginname'] = 'Exporter Prometheus';
-$string['setting_token'] = 'Token';
-$string['setting_token_desc'] = 'The token which has to be passed when the endpoint is called.';
+$string['settings:token'] = 'Token';
+$string['settings:token_desc'] = 'The token which has to be passed when the endpoint is called.';