String deprecation - Revision history

Devdocsbot: Update migration status and path

2022-05-16T10:27:41Z

Update migration status and path

← Older revision		Revision as of 10:27, 16 May 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/general/projects/api/string-deprecation}}
	{{Infobox Project		{{Infobox Project
	\|name = String deprecation		\|name = String deprecation

Devdocsbot: Protected "String deprecation": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-05-16T10:27:41Z

Protected "String deprecation": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 10:27, 16 May 2022
(No difference)

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:27:05Z

Text replacement - "</code>" to "</syntaxhighlight>"

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:36:52Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:36, 14 July 2021
				
Line 27:
Line 27:
Beware that searching for the string identifier only may sometimes lead to false negatives. Imagine you have a suspicion that a hypothetical string "actionloginremote" is no longer used any more as there is no code that would actually use this stringid. However, there can be places like this: Beware that searching for the string identifier only may sometimes lead to false negatives. Imagine you have a suspicion that a hypothetical string "actionloginremote" is no longer used any more as there is no code that would actually use this stringid. However, there can be places like this:



<code php> <syntaxhighlight lang="php">
$action = optional_param('action', 'loginremote', PARAM_ALPHA); $action = optional_param('action', 'loginremote', PARAM_ALPHA);
print_string('action'.$action); print_string('action'.$action);



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:04:59Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:04, 14 July 2021
				
Line 13:
Line 13:
== How it works == == How it works ==



There is a file with the list of deprecated strings. When a deprecated string is used (typically via the <code>get_string()</code> call), a warning message is displayed, such as: There is a file with the list of deprecated strings. When a deprecated string is used (typically via the <syntaxhighlight lang="php">get_string()</code> call), a warning message is displayed, such as:



     String [identifier,component] is deprecated. Either you should no longer be using that string,        String [identifier,component] is deprecated. Either you should no longer be using that string,  
Line 49:
Line 49:
* Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/'' * Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/''
* Add a line "identifier,fullcomponentname" to the end of this file * Add a line "identifier,fullcomponentname" to the end of this file
* Move the string inside the existing language file to the end of the file under the comment <code>// Deprecated since Moodle X.Y.</code> (this comment will help removing deprecated strings later). * Move the string inside the existing language file to the end of the file under the comment <syntaxhighlight lang="php">// Deprecated since Moodle X.Y.</code> (this comment will help removing deprecated strings later).
* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file. * For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.






Pholden: Fix comment, lest we upset glorious codechecker.
2020-10-21T17:01:04Z
Fix comment, lest we upset glorious codechecker.

				
				
				
				
				
				← Older revision
				Revision as of 17:01, 21 October 2020
				
Line 49:
Line 49:
* Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/'' * Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/''
* Add a line "identifier,fullcomponentname" to the end of this file * Add a line "identifier,fullcomponentname" to the end of this file
* Move the string inside the existing language file to the end of the file under the comment "// Deprecated since Moodle X.Y" (this comment will help removing deprecated strings later). * Move the string inside the existing language file to the end of the file under the comment <code>// Deprecated since Moodle X.Y.</code> (this comment will help removing deprecated strings later).
* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file. * For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.






Tsala: see also tracker issue link
2019-02-22T08:53:25Z
see also tracker issue link

				
				
				
				
				
				← Older revision
				Revision as of 08:53, 22 February 2019
				
Line 71:
Line 71:
   [https://github.com/moodle/moodle/blame/master/lang/en/deprecated.txt <nowiki>git blame lang/en/deprecated.txt</nowiki>]    [https://github.com/moodle/moodle/blame/master/lang/en/deprecated.txt <nowiki>git blame lang/en/deprecated.txt</nowiki>]
   [https://github.com/moodle/moodle/blame/master/mod/quiz/lang/en/deprecated.txt <nowiki>git blame mod/quiz/lang/en/deprecated.txt</nowiki>]    [https://github.com/moodle/moodle/blame/master/mod/quiz/lang/en/deprecated.txt <nowiki>git blame mod/quiz/lang/en/deprecated.txt</nowiki>]

==See also==

* MDL-64905 comments regarding introducing a new string and deprecating the old one



[[Category:Language]] [[Category:Language]]



Stronk7 at 23:14, 22 May 2016
2016-05-22T23:14:51Z


				
				
				
				
				
				← Older revision
				Revision as of 23:14, 22 May 2016
				
Line 54:
Line 54:
''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"'' ''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''



''Note: before Moodle 3.0, final deprecation was 2 major versions later. With 3.0 it was switched to current 4 major releases later'' ''Note: before Moodle 3.0, final deprecation was 2 major versions later. With 3.0 the policy switched to 4 major releases later''









Stronk7: Switch final deprecation from +2 to +4
2016-05-22T23:14:01Z
Switch final deprecation from +2 to +4

				
				
				
				
				
				← Older revision
				Revision as of 23:14, 22 May 2016
				
Line 50:
Line 50:
* Add a line "identifier,fullcomponentname" to the end of this file * Add a line "identifier,fullcomponentname" to the end of this file
* Move the string inside the existing language file to the end of the file under the comment "// Deprecated since Moodle X.Y" (this comment will help removing deprecated strings later). * Move the string inside the existing language file to the end of the file under the comment "// Deprecated since Moodle X.Y" (this comment will help removing deprecated strings later).
* For final deprecation (2 major versions later), delete the string from both deprecated.txt and respective lang file. * For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.



''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"'' ''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''

''Note: before Moodle 3.0, final deprecation was 2 major versions later. With 3.0 it was switched to current 4 major releases later''




Take care when deprecating a string within a few weeks of en_fix being merged with en, as it can result in a conflict (as happened in MDL-52315). Take care when deprecating a string within a few weeks of en_fix being merged with en, as it can result in a conflict (as happened in MDL-52315).



Tsala: /* How to deprecate a string */ possible conflict
2016-01-12T14:12:10Z
How to deprecate a string:  possible conflict

				
				
				
				
				
				← Older revision
				Revision as of 14:12, 12 January 2016
				
Line 53:
Line 53:



''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"'' ''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''

Take care when deprecating a string within a few weeks of en_fix being merged with en, as it can result in a conflict (as happened in MDL-52315).



== What to do if you get a debugging message == == What to do if you get a debugging message ==

← Older revision		Revision as of 20:27, 14 July 2021
Line 13:		Line 13:
	== How it works ==		== How it works ==

	There is a file with the list of deprecated strings. When a deprecated string is used (typically via the <syntaxhighlight lang="php">get_string()</~~code~~> call), a warning message is displayed, such as:		There is a file with the list of deprecated strings. When a deprecated string is used (typically via the <syntaxhighlight lang="php">get_string()</syntaxhighlight> call), a warning message is displayed, such as:

	String [identifier,component] is deprecated. Either you should no longer be using that string,		String [identifier,component] is deprecated. Either you should no longer be using that string,
Line 30:		Line 30:
	$action = optional_param('action', 'loginremote', PARAM_ALPHA);		$action = optional_param('action', 'loginremote', PARAM_ALPHA);
	print_string('action'.$action);		print_string('action'.$action);
	</~~code~~>		</syntaxhighlight>

	that are harder to detect. So, instead of simply removing the string "actionloginremote" you would put it to the list of deprecated strings.		that are harder to detect. So, instead of simply removing the string "actionloginremote" you would put it to the list of deprecated strings.
Line 49:		Line 49:
	* Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/''		* Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/''
	* Add a line "identifier,fullcomponentname" to the end of this file		* Add a line "identifier,fullcomponentname" to the end of this file
	* Move the string inside the existing language file to the end of the file under the comment <syntaxhighlight lang="php">// Deprecated since Moodle X.Y.</~~code~~> (this comment will help removing deprecated strings later).		* Move the string inside the existing language file to the end of the file under the comment <syntaxhighlight lang="php">// Deprecated since Moodle X.Y.</syntaxhighlight> (this comment will help removing deprecated strings later).
	* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.		* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.

← Older revision		Revision as of 13:36, 14 July 2021
Line 27:		Line 27:
	Beware that searching for the string identifier only may sometimes lead to false negatives. Imagine you have a suspicion that a hypothetical string "actionloginremote" is no longer used any more as there is no code that would actually use this stringid. However, there can be places like this:		Beware that searching for the string identifier only may sometimes lead to false negatives. Imagine you have a suspicion that a hypothetical string "actionloginremote" is no longer used any more as there is no code that would actually use this stringid. However, there can be places like this:

	<~~code~~ php>		<syntaxhighlight lang="php">
	$action = optional_param('action', 'loginremote', PARAM_ALPHA);		$action = optional_param('action', 'loginremote', PARAM_ALPHA);
	print_string('action'.$action);		print_string('action'.$action);

← Older revision		Revision as of 13:04, 14 July 2021
Line 13:		Line 13:
	== How it works ==		== How it works ==

	There is a file with the list of deprecated strings. When a deprecated string is used (typically via the <~~code~~>get_string()</code> call), a warning message is displayed, such as:		There is a file with the list of deprecated strings. When a deprecated string is used (typically via the <syntaxhighlight lang="php">get_string()</code> call), a warning message is displayed, such as:

	String [identifier,component] is deprecated. Either you should no longer be using that string,		String [identifier,component] is deprecated. Either you should no longer be using that string,
Line 49:		Line 49:
	* Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/''		* Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/''
	* Add a line "identifier,fullcomponentname" to the end of this file		* Add a line "identifier,fullcomponentname" to the end of this file
	* Move the string inside the existing language file to the end of the file under the comment <~~code~~>// Deprecated since Moodle X.Y.</code> (this comment will help removing deprecated strings later).		* Move the string inside the existing language file to the end of the file under the comment <syntaxhighlight lang="php">// Deprecated since Moodle X.Y.</code> (this comment will help removing deprecated strings later).
	* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.		* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.

← Older revision		Revision as of 17:01, 21 October 2020
Line 49:		Line 49:
	* Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/''		* Locate or create a file deprecated.txt either in ''lang/en/'' or ''componentfullpath/lang/en/''
	* Add a line "identifier,fullcomponentname" to the end of this file		* Add a line "identifier,fullcomponentname" to the end of this file
	* Move the string inside the existing language file to the end of the file under the comment "// Deprecated since Moodle X.Y" (this comment will help removing deprecated strings later).		* Move the string inside the existing language file to the end of the file under the comment <code>// Deprecated since Moodle X.Y.</code> (this comment will help removing deprecated strings later).
	* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.		* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.

← Older revision		Revision as of 08:53, 22 February 2019
Line 71:		Line 71:
	[https://github.com/moodle/moodle/blame/master/lang/en/deprecated.txt <nowiki>git blame lang/en/deprecated.txt</nowiki>]		[https://github.com/moodle/moodle/blame/master/lang/en/deprecated.txt <nowiki>git blame lang/en/deprecated.txt</nowiki>]
	[https://github.com/moodle/moodle/blame/master/mod/quiz/lang/en/deprecated.txt <nowiki>git blame mod/quiz/lang/en/deprecated.txt</nowiki>]		[https://github.com/moodle/moodle/blame/master/mod/quiz/lang/en/deprecated.txt <nowiki>git blame mod/quiz/lang/en/deprecated.txt</nowiki>]

			==See also==

			* MDL-64905 comments regarding introducing a new string and deprecating the old one

	[[Category:Language]]		[[Category:Language]]

← Older revision		Revision as of 23:14, 22 May 2016
Line 54:		Line 54:
	''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''		''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''

	''Note: before Moodle 3.0, final deprecation was 2 major versions later. With 3.0 ~~it was~~ switched to ~~current~~ 4 major releases later''		''Note: before Moodle 3.0, final deprecation was 2 major versions later. With 3.0 the policy switched to 4 major releases later''

← Older revision		Revision as of 23:14, 22 May 2016
Line 50:		Line 50:
	* Add a line "identifier,fullcomponentname" to the end of this file		* Add a line "identifier,fullcomponentname" to the end of this file
	* Move the string inside the existing language file to the end of the file under the comment "// Deprecated since Moodle X.Y" (this comment will help removing deprecated strings later).		* Move the string inside the existing language file to the end of the file under the comment "// Deprecated since Moodle X.Y" (this comment will help removing deprecated strings later).
	* For final deprecation (2 major versions later), delete the string from both deprecated.txt and respective lang file.		* For final deprecation (4 major versions later), delete the string from both deprecated.txt and respective lang file.

	''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''		''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''

			''Note: before Moodle 3.0, final deprecation was 2 major versions later. With 3.0 it was switched to current 4 major releases later''


	Take care when deprecating a string within a few weeks of en_fix being merged with en, as it can result in a conflict (as happened in MDL-52315).		Take care when deprecating a string within a few weeks of en_fix being merged with en, as it can result in a conflict (as happened in MDL-52315).

← Older revision		Revision as of 14:12, 12 January 2016
Line 53:		Line 53:

	''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''		''Note: when deprecating core string from lang/en/xxxx.php the fullcomponentname should be "core_xxxx", except for lang/en/moodle.php that has fullcomponentname "core"''

			Take care when deprecating a string within a few weeks of en_fix being merged with en, as it can result in a conflict (as happened in MDL-52315).

	== What to do if you get a debugging message ==		== What to do if you get a debugging message ==