MediaWiki  master
AutoLoader.php
Go to the documentation of this file.
1 <?php
28 require_once __DIR__ . '/../autoload.php';
29 
30 class AutoLoader {
31  protected static $autoloadLocalClassesLower = null;
32 
37  public static $psr4Namespaces = [];
38 
44  static function autoload( $className ) {
47 
48  $filename = false;
49 
50  if ( isset( $wgAutoloadLocalClasses[$className] ) ) {
51  $filename = $wgAutoloadLocalClasses[$className];
52  } elseif ( isset( $wgAutoloadClasses[$className] ) ) {
53  $filename = $wgAutoloadClasses[$className];
54  } elseif ( $wgAutoloadAttemptLowercase ) {
55  /*
56  * Try a different capitalisation.
57  *
58  * PHP 4 objects are always serialized with the classname coerced to lowercase,
59  * and we are plagued with several legacy uses created by MediaWiki < 1.5, see
60  * https://wikitech.wikimedia.org/wiki/Text_storage_data
61  */
62  $lowerClass = strtolower( $className );
63 
64  if ( self::$autoloadLocalClassesLower === null ) {
65  self::$autoloadLocalClassesLower = array_change_key_case( $wgAutoloadLocalClasses, CASE_LOWER );
66  }
67 
68  if ( isset( self::$autoloadLocalClassesLower[$lowerClass] ) ) {
69  if ( function_exists( 'wfDebugLog' ) ) {
70  wfDebugLog( 'autoloader', "Class {$className} was loaded using incorrect case" );
71  }
72  $filename = self::$autoloadLocalClassesLower[$lowerClass];
73  }
74  }
75 
76  if ( !$filename && strpos( $className, '\\' ) !== false ) {
77  // This class is namespaced, so try looking at the namespace map
78  $prefix = $className;
79  while ( false !== $pos = strrpos( $prefix, '\\' ) ) {
80  // Check to see if this namespace prefix is in the map
81  $prefix = substr( $className, 0, $pos + 1 );
82  if ( isset( self::$psr4Namespaces[$prefix] ) ) {
83  $relativeClass = substr( $className, $pos + 1 );
84  // Build the expected filename, and see if it exists
85  $file = self::$psr4Namespaces[$prefix] . '/' .
86  str_replace( '\\', '/', $relativeClass ) . '.php';
87  if ( file_exists( $file ) ) {
88  $filename = $file;
89  break;
90  }
91  }
92 
93  // Remove trailing separator for next iteration
94  $prefix = rtrim( $prefix, '\\' );
95  }
96  }
97 
98  if ( !$filename ) {
99  // Class not found; let the next autoloader try to find it
100  return;
101  }
102 
103  // Make an absolute path, this improves performance by avoiding some stat calls
104  if ( substr( $filename, 0, 1 ) != '/' && substr( $filename, 1, 1 ) != ':' ) {
105  global $IP;
106  $filename = "$IP/$filename";
107  }
108 
109  require $filename;
110  }
111 
116  static function resetAutoloadLocalClassesLower() {
117  self::$autoloadLocalClassesLower = null;
118  }
119 
130  public static function getAutoloadNamespaces() {
131  return [
132  'MediaWiki\\Auth\\' => __DIR__ . '/auth/',
133  'MediaWiki\\Block\\' => __DIR__ . '/block/',
134  'MediaWiki\\Edit\\' => __DIR__ . '/edit/',
135  'MediaWiki\\EditPage\\' => __DIR__ . '/editpage/',
136  'MediaWiki\\Linker\\' => __DIR__ . '/linker/',
137  'MediaWiki\\Permissions\\' => __DIR__ . '/Permissions/',
138  'MediaWiki\\Preferences\\' => __DIR__ . '/preferences/',
139  'MediaWiki\\Revision\\' => __DIR__ . '/Revision/',
140  'MediaWiki\\Session\\' => __DIR__ . '/session/',
141  'MediaWiki\\Shell\\' => __DIR__ . '/shell/',
142  'MediaWiki\\Sparql\\' => __DIR__ . '/sparql/',
143  'MediaWiki\\Storage\\' => __DIR__ . '/Storage/',
144  'MediaWiki\\Tidy\\' => __DIR__ . '/tidy/',
145  'Wikimedia\\Services\\' => __DIR__ . '/libs/services/',
146  ];
147  }
148 }
149 
151 spl_autoload_register( [ 'AutoLoader', 'autoload' ] );
$IP
Definition: WebStart.php:41
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
static $autoloadLocalClassesLower
Definition: AutoLoader.php:31
static autoload( $className)
autoload - take a class name and attempt to load it
Definition: AutoLoader.php:44
Locations of core classes Extension classes are specified with $wgAutoloadClasses This array is a glo...
Definition: AutoLoader.php:30
$wgAutoloadAttemptLowercase
Switch controlling legacy case-insensitive classloading.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
global $wgAutoloadLocalClasses
Definition: autoload.php:4
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
$wgAutoloadClasses
Array mapping class names to filenames, for autoloading.
static resetAutoloadLocalClassesLower()
Method to clear the protected class property $autoloadLocalClassesLower.
Definition: AutoLoader.php:116
static getAutoloadNamespaces()
Get a mapping of namespace => file path The namespaces should follow the PSR-4 standard for autoloadi...
Definition: AutoLoader.php:130
static string [] $psr4Namespaces
Definition: AutoLoader.php:37