MDL-80005 core: Formally deprecate PARAM_CLEANFILE

This commit is contained in:
Andrew Nicols 2023-11-07 23:12:51 +08:00
parent b05fc42db9
commit 6f23ef183d
No known key found for this signature in database
GPG key ID: 6D1E3157C8CFBF14
3 changed files with 8 additions and 0 deletions

View file

@ -299,7 +299,13 @@ enum param: string {
/** /**
* PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
* @deprecated since 2.0
*/ */
#[deprecated(
'param::CLEANFILE',
since: '2.0',
reason: 'Alias for PARAM_FILE',
)]
case CLEANFILE = 'cleanfile'; case CLEANFILE = 'cleanfile';
/** /**

View file

@ -310,6 +310,7 @@ define('PARAM_TIMEZONE', \core\param::TIMEZONE->value);
/** /**
* PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
* @deprecated since 2.0
*/ */
define('PARAM_CLEANFILE', \core\param::CLEANFILE->value); define('PARAM_CLEANFILE', \core\param::CLEANFILE->value);

View file

@ -31,6 +31,7 @@ information provided here is intended especially for developers.
* A new \core\deprecation class can be used to inspect for deprecated attributes: * A new \core\deprecation class can be used to inspect for deprecated attributes:
- `\core\deprecation::is_deprecated(example::class);` - `\core\deprecation::is_deprecated(example::class);`
- `\core\deprecation::emit_deprecation_if_present([self::class, 'some_method']);` - `\core\deprecation::emit_deprecation_if_present([self::class, 'some_method']);`
* Added missing deprecation for PARAM_CLEANFILE which was deprecated in Moodle 2.0.
=== 4.3 === === 4.3 ===