MDL-76583 core_external: Migrate external_format_value class

moodle · Jan 18, 2023 · e460e2e · e460e2e
1 parent 780ba13
commit e460e2e
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 37 deletions.
diff --git a/lib/external/classes/external_format_value.php b/lib/external/classes/external_format_value.php
@@ -0,0 +1,54 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace core_external;
+
+/**
+ * A pre-filled external_value class for text format.
+ *
+ * Default is FORMAT_HTML
+ * This should be used all the time in external xxx_params()/xxx_returns functions
+ * as it is the standard way to implement text format param/return values.
+ *
+ * @package    core_webservice
+ * @copyright  2012 Jerome Mouneyrac
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.3
+ */
+class external_format_value extends external_value {
+
+    /**
+     * Constructor
+     *
+     * @param string $textfieldname Name of the text field
+     * @param int $required if VALUE_REQUIRED then set standard default FORMAT_HTML
+     * @param int $default Default value.
+     * @since Moodle 2.3
+     */
+    public function __construct($textfieldname, $required = VALUE_REQUIRED, $default = null) {
+
+        if ($default == null && $required == VALUE_DEFAULT) {
+            $default = FORMAT_HTML;
+        }
+
+        $desc = $textfieldname . ' format (' . FORMAT_HTML . ' = HTML, '
+                . FORMAT_MOODLE . ' = MOODLE, '
+                . FORMAT_PLAIN . ' = PLAIN or '
+                . FORMAT_MARKDOWN . ' = MARKDOWN)';
+
+        parent::__construct(PARAM_INT, $desc, $required, $default);
+    }
+}
diff --git a/lib/externallib.php b/lib/externallib.php
@@ -29,6 +29,7 @@ class_alias(\core_external\external_api::class, 'external_api');
 class_alias(\core_external\restricted_context_exception::class, 'restricted_context_exception');
 class_alias(\core_external\external_description::class, 'external_description');
 class_alias(\core_external\external_value::class, 'external_value');
+class_alias(\core_external\external_format_value::class, 'external_format_value');
 class_alias(\core_external\external_single_structure::class, 'external_single_structure');
 class_alias(\core_external\external_multiple_structure::class, 'external_multiple_structure');
 class_alias(\core_external\external_function_parameters::class, 'external_function_parameters');
@@ -133,43 +134,6 @@ function external_delete_descriptions($component) {
     $DB->delete_records('external_functions', array('component'=>$component));
 }
 
-/**
- * A pre-filled external_value class for text format.
- *
- * Default is FORMAT_HTML
- * This should be used all the time in external xxx_params()/xxx_returns functions
- * as it is the standard way to implement text format param/return values.
- *
- * @package    core_webservice
- * @copyright  2012 Jerome Mouneyrac
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.3
- */
-class external_format_value extends external_value {
-
-    /**
-     * Constructor
-     *
-     * @param string $textfieldname Name of the text field
-     * @param int $required if VALUE_REQUIRED then set standard default FORMAT_HTML
-     * @param int $default Default value.
-     * @since Moodle 2.3
-     */
-    public function __construct($textfieldname, $required = VALUE_REQUIRED, $default = null) {
-
-        if ($default == null && $required == VALUE_DEFAULT) {
-            $default = FORMAT_HTML;
-        }
-
-        $desc = $textfieldname . ' format (' . FORMAT_HTML . ' = HTML, '
-                . FORMAT_MOODLE . ' = MOODLE, '
-                . FORMAT_PLAIN . ' = PLAIN or '
-                . FORMAT_MARKDOWN . ' = MARKDOWN)';
-
-        parent::__construct(PARAM_INT, $desc, $required, $default);
-    }
-}
-
 /**
  * Validate text field format against known FORMAT_XXX
  *