Environment checking - Revision history

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


2021-07-15T08:13:06Z
Text replacement - "<code (.*)>" to "<syntaxhighlight lang="$1">"

				
				
				
				
				
				← Older revision
				Revision as of 08:13, 15 July 2021
				
Line 7:
Line 7:
The process is controlled by the the /admin/environment.xml file, which looks roughly like this: The process is controlled by the the /admin/environment.xml file, which looks roughly like this:



<code xml> <syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<COMPATIBILITY_MATRIX> <COMPATIBILITY_MATRIX>

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

2021-07-14T13:02:46Z

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

← Older revision		Revision as of 13:02, 14 July 2021
Line 18:		Line 18:
	<!-- etc. -->		<!-- etc. -->
	</COMPATIBILITY_MATRIX>		</COMPATIBILITY_MATRIX>
	</~~code~~>		</syntaxhighlight>

	The 'Various conditions' that can be tested are described below.		The 'Various conditions' that can be tested are described below.

Danowar: /* Feedback messages */

2017-07-18T13:53:29Z

Feedback messages

← Older revision		Revision as of 13:53, 18 July 2017
Line 46:		Line 46:

	If level="required" it must be <ON_ERROR>, but if level="optional", you have to use <ON_CHECK>. I don't know why. The whole <FEEDBACK> element is optional, as are any or all of the <ON_ERROR>, <ON_CHECK> or <ON_OK> elements. Any messages you provide will be displayed, if appropriate, otherwise not.		If level="required" it must be <ON_ERROR>, but if level="optional", you have to use <ON_CHECK>. I don't know why. The whole <FEEDBACK> element is optional, as are any or all of the <ON_ERROR>, <ON_CHECK> or <ON_OK> elements. Any messages you provide will be displayed, if appropriate, otherwise not.

			In plugins, the message can be taken from lang/admin.php or from the plugin itself.
			Example:
			<pre>
			<FEEDBACK>
			<ON_ERROR message="failmessage" plugin="plugintype_plugin_name_where_string_is_defined"/>
			</FEEDBACK>
			</pre>

	The message is looked up using get_string($stringtouse, 'admin', $rec), where $rec holds a bunch of information. This is done in the print_moodle_environment function in lib/environmentlib.php.		The message is looked up using get_string($stringtouse, 'admin', $rec), where $rec holds a bunch of information. This is done in the print_moodle_environment function in lib/environmentlib.php.

Mudrd8mz: /* Configuration file overview */ Improve the XML file example

2015-11-26T11:54:27Z

Configuration file overview: Improve the XML file example

← Older revision		Revision as of 11:54, 26 November 2015
Line 7:		Line 7:
	The process is controlled by the the /admin/environment.xml file, which looks roughly like this:		The process is controlled by the the /admin/environment.xml file, which looks roughly like this:

	<~~pre~~>		<code xml>
			<?xml version="1.0" encoding="UTF-8" ?>
	<COMPATIBILITY_MATRIX>		<COMPATIBILITY_MATRIX>
	<MOODLE version="1.5">		<MOODLE version="3.0">
	<!-- Various conditions -->		<!-- Various conditions -->
	</MOODLE>		</MOODLE>
	<MOODLE version="1.6">		<MOODLE version="3.1">
	<!-- Various conditions -->		<!-- Various conditions -->
	</MOODLE>		</MOODLE>
	<!-- etc. -->		<!-- etc. -->
	</COMPATIBILITY_MATRIX>		</COMPATIBILITY_MATRIX>
	</~~pre~~>		</code>

	The 'Various conditions' that can be tested are described below.		The 'Various conditions' that can be tested are described below.

Stronk7: Added information about latest environment.xml improvements (MDL-39840 and MDL-48177)

2015-01-27T16:50:30Z

Added information about latest environment.xml improvements (MDL-39840 and MDL-48177)

← Older revision		Revision as of 16:50, 27 January 2015
Line 20:		Line 20:

	The 'Various conditions' that can be tested are described below.		The 'Various conditions' that can be tested are described below.

			{{Moodle 2.8}}
			Note that, since Moodle 2.6.5, 2.7.2 and 2.8 it's possible, for additional plugins, never for core, to have their '''own environment.xml files''' (under own root directory) where any other environment check can be added, following the same rules than the main /admin/environment.xml one (see MDL-39840 for more details).

			{{Moodle 2.9}}
			Also, since Moodle 2.9, within additional plugins environment.xml files, it's possible to replace the <MOODLE version="x.y"> element by a simpler <PLUGIN name="frankenstyle_name"> that will be applied '''for all the versions''' of the plugin. The use of this new tag gets precedence over any <MOODLE> tag so usually you must decide between the '''versioned or un-versioned''' alternatives (see MDL-48177 for more details).

	==Things that apply to all tests==		==Things that apply to all tests==

Deraadt: /* Custom checks */

2011-06-15T08:30:19Z

Custom checks

← Older revision		Revision as of 08:30, 15 June 2011
Line 129:		Line 129:

	'''Note''': please do not abuse custom checks when you are doing something that should actually be implemented as a new type of check in environment lib. It's highly recommended to comment about your new custom check at [http://moodle.org/mod/forum/view.php?id=55 General Developer Forum] '''before''' implementing it.		'''Note''': please do not abuse custom checks when you are doing something that should actually be implemented as a new type of check in environment lib. It's highly recommended to comment about your new custom check at [http://moodle.org/mod/forum/view.php?id=55 General Developer Forum] '''before''' implementing it.

	~~[[Category:Environment checking]]~~

Nakohdo: /* Unicode */

2009-05-07T07:02:15Z

Unicode

← Older revision		Revision as of 07:02, 7 May 2009
Line 102:		Line 102:
	</pre>		</pre>

	===Custom checks=== {{Moodle 1.9}}		=== Custom checks ===
			{{Moodle 1.9}}

	This runs a custom PHP function that returns true or false.		This runs a custom PHP function that returns true or false.

Ddarjany at 19:30, 16 January 2008

2008-01-16T19:30:48Z

← Older revision		Revision as of 19:30, 16 January 2008
Line 1:		Line 1:
	When you install or upgrade Moodle, ~~before~~ before the install actually changes anything, it takes you to the /admin/environment.php page, to check that various aspects of your server meets the minimum requirement. For example, it checks PHP version, database version, various PHP extensions, and so on.		When you install or upgrade Moodle, before the install actually changes anything, it takes you to the /admin/environment.php page, to check that various aspects of your server meets the minimum requirement. For example, it checks PHP version, database version, various PHP extensions, and so on.

	The code to actually do the checking is in lib/environmentlib.php. The main entry point is the check_moodle_environment function, which runs the appropriate check using environment_check, then displays the results using print_moodle_environment.		The code to actually do the checking is in lib/environmentlib.php. The main entry point is the check_moodle_environment function, which runs the appropriate check using environment_check, then displays the results using print_moodle_environment.

Tsala: cat edit

2007-06-18T09:06:57Z

cat edit

← Older revision		Revision as of 09:06, 18 June 2007
Line 128:		Line 128:

	'''Note''': please do not abuse custom checks when you are doing something that should actually be implemented as a new type of check in environment lib. It's highly recommended to comment about your new custom check at [http://moodle.org/mod/forum/view.php?id=55 General Developer Forum] '''before''' implementing it.		'''Note''': please do not abuse custom checks when you are doing something that should actually be implemented as a new type of check in environment lib. It's highly recommended to comment about your new custom check at [http://moodle.org/mod/forum/view.php?id=55 General Developer Forum] '''before''' implementing it.

			[[Category:Environment checking]]

Stronk7: moving 1.9 template to the custom checks section

2007-04-27T18:45:53Z

moving 1.9 template to the custom checks section

← Older revision		Revision as of 18:45, 27 April 2007
Line 1:		Line 1:
	~~{{Moodle 1.9}}~~
	When you install or upgrade Moodle, before before the install actually changes anything, it takes you to the /admin/environment.php page, to check that various aspects of your server meets the minimum requirement. For example, it checks PHP version, database version, various PHP extensions, and so on.		When you install or upgrade Moodle, before before the install actually changes anything, it takes you to the /admin/environment.php page, to check that various aspects of your server meets the minimum requirement. For example, it checks PHP version, database version, various PHP extensions, and so on.

Line 103:		Line 102:
	</pre>		</pre>

	===Custom checks===		===Custom checks=== {{Moodle 1.9}}

	This runs a custom PHP function that returns true or false.		This runs a custom PHP function that returns true or false.

← Older revision		Revision as of 08:13, 15 July 2021
Line 7:		Line 7:
	The process is controlled by the the /admin/environment.xml file, which looks roughly like this:		The process is controlled by the the /admin/environment.xml file, which looks roughly like this:

	<~~code~~ xml>		<syntaxhighlight lang="xml">
	<?xml version="1.0" encoding="UTF-8" ?>		<?xml version="1.0" encoding="UTF-8" ?>
	<COMPATIBILITY_MATRIX>		<COMPATIBILITY_MATRIX>