moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-04 16:36:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-76583 core_external: Update util string formatting functions

Browse source
This commit is contained in:
Andrew Nicols 2022-12-15 14:43:50 +08:00
parent d5d4ff8986
commit 47814221e5
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/external/classes/util.php vendored
View file

@ -429,14 +429,14 @@ class util {
* All web service servers must set this singleton when parsing the $_GET and $_POST. * All web service servers must set this singleton when parsing the $_GET and $_POST.
* *
* <pre> * <pre>
* Options are the same that in {@link format_string()} with some changes: * Options are the same that in {@see format_string()} with some changes:
* filter : Can be set to false to force filters off, else observes {@link settings}. * filter : Can be set to false to force filters off, else observes {@see settings}.
* </pre> * </pre>
* *
* @param string|null $content The string to be filtered. Should be plain text, expect * @param string|null $content The string to be filtered. Should be plain text, expect
* possibly for multilang tags. * possibly for multilang tags.
* @param context $context The id of the context for the string or the context (affects filters).
* @param boolean $striplinks To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713 * @param boolean $striplinks To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713
* @param context $contextorid The id of the context for the string or the context (affects filters).
* @param array $options options array/object or courseid * @param array $options options array/object or courseid
* @return string text * @return string text
*/ */
@ -472,11 +472,11 @@ class util {
* All web service servers must set this singleton when parsing the $_GET and $_POST. * All web service servers must set this singleton when parsing the $_GET and $_POST.
* *
* <pre> * <pre>
* Options are the same that in {@link format_text()} with some changes in defaults to provide backwards compatibility: * Options are the same that in {@see format_text()} with some changes in defaults to provide backwards compatibility:
* trusted : If true the string won't be cleaned. Default false. * trusted : If true the string won't be cleaned. Default false.
* noclean : If true the string won't be cleaned only if trusted is also true. Default false. * noclean : If true the string won't be cleaned only if trusted is also true. Default false.
* nocache : If true the string will not be cached and will be formatted every call. Default false. * nocache : If true the string will not be cached and will be formatted every call. Default false.
* filter : Can be set to false to force filters off, else observes {@link \core_external\settings}. * filter : Can be set to false to force filters off, else observes {@see \core_external\settings}.
* para : If true then the returned string will be wrapped in div tags. * para : If true then the returned string will be wrapped in div tags.
* Default (different from format_text) false. * Default (different from format_text) false.
* Default changed because div tags are not commonly needed. * Default changed because div tags are not commonly needed.
@ -578,14 +578,14 @@ class util {
* @since Moodle 2.3 * @since Moodle 2.3
*/ */
public static function validate_format($format) { public static function validate_format($format) {
$allowedformats = array(FORMAT_HTML, FORMAT_MOODLE, FORMAT_PLAIN, FORMAT_MARKDOWN); $allowedformats = [FORMAT_HTML, FORMAT_MOODLE, FORMAT_PLAIN, FORMAT_MARKDOWN];
if (!in_array($format, $allowedformats)) { if (!in_array($format, $allowedformats)) {
throw new moodle_exception( throw new moodle_exception(
'formatnotsupported', 'formatnotsupported',
'webservice', 'webservice',
'', '',
null, null,
'The format with value=' . $format . ' is not supported by this Moodle site' "The format with value={$format} is not supported by this Moodle site"
); );
} }
return $format; return $format;