Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
environmentlib.php File Reference

Classes

class  environment_results
 Helper Class to return results to caller. More...
 

Functions

 check_moodle_environment ($version, $env_select=ENV_SELECT_NEWER)
 This function checks all the requirements defined in environment.xml.
 
object environment_check ($version, $env_select)
 This function will check for everything (DB, PHP and PHP extensions for now) returning an array of environment_result objects.
 
 environment_check_database ($version, $env_select)
 This function will check if database requirements are satisfied.
 
 environment_check_moodle ($version, $env_select)
 This function will check if Moodle requirements are satisfied.
 
 environment_check_pcre_unicode ($version, $env_select)
 Looks for buggy PCRE implementation, we need unicode support in Moodle...
 
 environment_check_php ($version, $env_select)
 This function will check if php requirements are satisfied.
 
 environment_check_php_extensions ($version, $env_select)
 This function will check if php extensions requirements are satisfied.
 
 environment_check_php_settings ($version, $env_select)
 This function will check if php extensions requirements are satisfied.
 
 environment_check_unicode ($version, $env_select)
 This function will check if unicode database requirements are satisfied.
 
 environment_custom_checks ($version, $env_select)
 This function will do the custom checks.
 
 environment_get_errors ($environment_results)
 Returns array of critical errors in plain text format.
 
 environment_verify_plugin ($plugin, $pluginxml)
 Checks if a plugin tag has a name attribute and it matches the plugin being tested.
 
 get_environment_for_version ($version, $env_select)
 This function will return the xmlized data belonging to one Moodle version.
 
 get_latest_version_available ($version, $env_select)
 This function will return the most recent version in the environment.xml file previous or equal to the version requested.
 
 get_level ($element)
 Here all the restrict functions are coded to be used by the environment checker.
 
 get_list_of_environment_versions ($contents)
 This function will return the list of Moodle versions available.
 
 load_environment_xml ($env_select=ENV_SELECT_NEWER)
 This function will load the environment.xml file and xmlize it.
 
 normalize_version ($version)
 This function will normalize any version to just a serie of numbers separated by dots.
 
 process_environment_bypass ($xml, &$result)
 This function will post-process the result record by executing the specified function, modifying it as necessary, also a custom message will be added to the result object to be printed by the display layer.
 
 process_environment_messages ($xml, &$result)
 This function will detect if there is some message available to be added to the result in order to clarify enviromental details.
 
 process_environment_restrict ($xml, &$result)
 This function will post-process the result record by executing the specified function, modifying it as necessary, also a custom message will be added to the result object to be printed by the display layer.
 
 process_environment_result ($element, &$result)
 Once the result has been determined, look in the XML for any messages, or other things that should be done depending on the outcome.
 
 restrict_php_version (&$result, $version)
 Check if the current PHP version is greater than or equal to an unsupported version.
 
 restrict_php_version_7 (&$result)
 Check if the current PHP version is greater than or equal to PHP version 7.
 
 restrict_php_version_71 (&$result)
 Check if the current PHP version is greater than or equal to PHP version 7.1.
 
 restrict_php_version_72 (&$result)
 Check if the current PHP version is greater than or equal to PHP version 7.2.
 
 restrict_php_version_73 (&$result)
 Check if the current PHP version is greater than or equal to PHP version 7.3.
 
 restrict_php_version_74 (&$result)
 Check if the current PHP version is greater than or equal to PHP version 7.4.
 
 restrict_php_version_80 ($result)
 Check if the current PHP version is greater than or equal to PHP version 8.0.
 
 restrict_php_version_81 ($result)
 Check if the current PHP version is greater than or equal to PHP version 8.1.
 
 restrict_php_version_82 ($result)
 Check if the current PHP version is greater than or equal to PHP version 8.2.
 
 restrict_php_version_83 ($result)
 Check if the current PHP version is greater than or equal to PHP version 8.3.
 

Variables

const CUSTOM_CHECK_FILE_MISSING 13
 XML Processing Error.
 
const CUSTOM_CHECK_FUNCTION_MISSING 14
 XML Processing Error.
 
const ENV_SELECT_DATAROOT 1
 To enforce the use of the file under dataroot.
 
const ENV_SELECT_NEWER 0
 Define algorithm used to select the xml file.
 
const ENV_SELECT_RELEASE 2
 To enforce the use of the file under admin (release)
 
const INCORRECT_FEEDBACK_FOR_OPTIONAL 17
 XML Processing Error.
 
const INCORRECT_FEEDBACK_FOR_REQUIRED 16
 XML Processing Error.
 
const NO_CUSTOM_CHECK_FOUND 12
 XML Processing Error.
 
const NO_DATABASE_SECTION_FOUND 2
 XML Processing Error.
 
const NO_DATABASE_VENDOR_MYSQL_FOUND 4
 XML Processing Error.
 
const NO_DATABASE_VENDOR_POSTGRES_FOUND 5
 XML Processing Error.
 
const NO_DATABASE_VENDOR_VERSION_FOUND 10
 XML Processing Error.
 
const NO_DATABASE_VENDORS_FOUND 3
 XML Processing Error.
 
const NO_ERROR 0
 Add required files.
 
const NO_PHP_EXTENSIONS_NAME_FOUND 9
 XML Processing Error.
 
const NO_PHP_EXTENSIONS_SECTION_FOUND 8
 XML Processing Error.
 
const NO_PHP_SECTION_FOUND 6
 XML Processing Error.
 
const NO_PHP_SETTINGS_NAME_FOUND 15
 XML Processing Error.
 
const NO_PHP_VERSION_FOUND 7
 XML Processing Error.
 
const NO_UNICODE_SECTION_FOUND 11
 XML Processing Error.
 
const NO_VERSION_DATA_FOUND 1
 XML Processing Error.