lib/customcheckslib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * This is a place to put custom environment checks, if there is not a better place.
  19  *
  20  * This library contains a collection of functions able to perform
  21  * some custom checks executed by environmental tests (automatically
  22  * executed on install & upgrade and under petition in the admin block).
  23  *
  24  * Any function in this library gets a environment_results object passed in.
  25  * It must return:
  26  * - null: if the test isn't relevant and must not be showed (ignored)
  27  * - the environment_results object that was passed in, with the status set to:
  28  *     - true: if passed
  29  *     - false: if failed
  30  *
  31  * @package    core
  32  * @subpackage admin
  33  * @copyright  (C) 2001-3001 Eloy Lafuente (stronk7) {@link http://contiento.com}
  34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35  */
  36
  37 defined('MOODLE_INTERNAL') || die();