lib/db/renamedclasses.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 file contains mappings for classes that have been renamed so that they meet the requirements of the autoloader.
  19  *
  20  * Renaming isn't always the recommended approach, but can provide benefit in situations where we've already got a
  21  * close structure, OR where lots of classes get included and not necessarily used, or checked for often.
  22  *
  23  * When renaming a class delete the original class and add an entry to the db/renamedclasses.php directory for that
  24  * component.
  25  * This way we don't need to keep around old classes, instead creating aliases only when required.
  26  * One big advantage to this method is that we provide consistent debugging for renamed classes when they are used.
  27  *
  28  * @package    core
  29  * @copyright  2014 Sam Hemelryk
  30  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31  */
  32
  33 defined('MOODLE_INTERNAL') || die();
  34
  35 // Like other files in the db directory this file uses an array.
  36 // The old class name is the key, the new class name is the value.
  37 // The array must be called $renamedclasses.
  38 // TODO MDL-57244 These renamed classes will be removed in 3.6
  39 $renamedclasses = array(
  40     'core\progress\null' => 'core\progress\none',
  41     'core_search\area\base' => 'core_search\base',
  42     'core_search\area\base_mod' => 'core_search\base_mod',
  43     'core_search\area\base_activity' => 'core_search\base_activity',
  44     'core_competency\\external\\exporter' => 'core\\external\\exporter',
  45     'core_competency\\external\\persistent_exporter' => 'core\\external\\persistent_exporter',
  46     'core_competency\\external\\comment_area_exporter' => 'core_comment\\external\\comment_area_exporter',
  47     'core_competency\\external\\stored_file_exporter' => 'core_files\\external\\stored_file_exporter',
  48     'core_competency\\external\\user_summary_exporter' => 'core_user\\external\\user_summary_exporter'
  49 );