AutoLoader.php
No OneTemporary
Actions

Size

12 KB

Referenced Files

None

Subscribers

None

AutoLoader.php
View Options

	<?php
	/**
	* @license GPL-2.0-or-later
	* @file
	*/

	// NO_AUTOLOAD -- file scope code, can't load self

	/**
	* Locations of core classes
	* Extension classes are specified with $wgAutoloadClasses
	*/
	require_once __DIR__ . '/../autoload.php';

	/**
	* @defgroup Autoload Autoload
	*/

	/**
	* This initializes autoloading for MediaWiki core, extensions, and vendored libs.
	*
	* NOTE: This file sets up the PHP autoloader and so its stable contract is not this
	* class, but the act of initializing spl_autoload_register and vendor.
	* This file is widely referenced (akin to includes/Defines.php) and is therefore
	* not renamed or moved to /includes/autoload.
	*
	* @since 1.7
	* @ingroup Autoload
	*/
	class AutoLoader {

	/**
	* A mapping of namespace => file path for MediaWiki core.
	* The namespaces must follow the PSR-4 standard for autoloading.
	*
	* MediaWiki core does not use PSR-4 autoloading due to performance issues,
	* but enforce the mapping to be maintained for future use.
	* Instead using PSR-0, class map stored in autoload.php generated via script:
	* php maintenance/run.php generateLocalAutoload
	*
	* @see <https://www.php-fig.org/psr/psr-4/>
	* @see <https://techblog.wikimedia.org/2024/01/16/web-perf-hero-mate-szabo/>
	* @internal Only public for usage in AutoloadGenerator/AutoLoaderTest
	* @phpcs-require-sorted-array
	*/
	public const CORE_NAMESPACES = [
	'MediaWiki\\' => __DIR__ . '/',
	'MediaWiki\\Actions\\' => __DIR__ . '/actions/',
	'MediaWiki\\Api\\' => __DIR__ . '/api/',
	'MediaWiki\\Auth\\' => __DIR__ . '/auth/',
	'MediaWiki\\Block\\' => __DIR__ . '/block/',
	'MediaWiki\\Cache\\' => __DIR__ . '/cache/',
	'MediaWiki\\ChangeTags\\' => __DIR__ . '/changetags/',
	'MediaWiki\\Collation\\' => __DIR__ . '/collation/',
	'MediaWiki\\Composer\\' => __DIR__ . '/composer/',
	'MediaWiki\\Config\\' => __DIR__ . '/config/',
	'MediaWiki\\Content\\' => __DIR__ . '/content/',
	'MediaWiki\\Context\\' => __DIR__ . '/context/',
	'MediaWiki\\DAO\\' => __DIR__ . '/dao/',
	'MediaWiki\\DB\\' => __DIR__ . '/db/',
	'MediaWiki\\Debug\\' => __DIR__ . '/debug/',
	'MediaWiki\\Deferred\\' => __DIR__ . '/deferred/',
	'MediaWiki\\Deferred\\LinksUpdate\\' => __DIR__ . '/deferred/LinksUpdate/',
	'MediaWiki\\Diff\\' => __DIR__ . '/diff/',
	'MediaWiki\\EditPage\\' => __DIR__ . '/editpage/',
	'MediaWiki\\Edit\\' => __DIR__ . '/edit/',
	'MediaWiki\\Exception\\' => __DIR__ . '/exception/',
	'MediaWiki\\Export\\' => __DIR__ . '/export/',
	'MediaWiki\\FileBackend\\' => __DIR__ . '/filebackend/',
	'MediaWiki\\FileBackend\\FSFile\\' => __DIR__ . '/libs/filebackend/fsfile/',
	'MediaWiki\\FileBackend\\LockManager\\' => __DIR__ . '/filebackend/lockmanager/',
	'MediaWiki\\FileRepo\\' => __DIR__ . '/filerepo/',
	'MediaWiki\\FileRepo\\File\\' => __DIR__ . '/filerepo/file/',
	'MediaWiki\\HTMLForm\\' => __DIR__ . '/htmlform/',
	'MediaWiki\\HTMLForm\\Field\\' => __DIR__ . '/htmlform/fields/',
	'MediaWiki\\Http\\' => __DIR__ . '/http/',
	'MediaWiki\\Installer\\' => __DIR__ . '/installer/',
	'MediaWiki\\Interwiki\\' => __DIR__ . '/interwiki/',
	'MediaWiki\\JobQueue\\' => __DIR__ . '/jobqueue/',
	'MediaWiki\\JobQueue\\Exceptions\\' => __DIR__ . '/jobqueue/exception/',
	'MediaWiki\\JobQueue\\Jobs\\' => __DIR__ . '/jobqueue/jobs/',
	'MediaWiki\\JobQueue\\Utils\\' => __DIR__ . '/jobqueue/utils/',
	'MediaWiki\\Json\\' => __DIR__ . '/json/',
	'MediaWiki\\Languages\\Data\\' => __DIR__ . '/languages/data/',
	'MediaWiki\\Language\\' => __DIR__ . '/language/',
	'MediaWiki\\LinkedData\\' => __DIR__ . '/linkeddata/',
	'MediaWiki\\Linker\\' => __DIR__ . '/linker/',
	'MediaWiki\\Logger\\' => __DIR__ . '/debug/logger/',
	'MediaWiki\\Logger\\Monolog\\' => __DIR__ . '/debug/logger/monolog/',
	'MediaWiki\\Logging\\' => __DIR__ . '/logging/',
	'MediaWiki\\Mail\\' => __DIR__ . '/mail/',
	'MediaWiki\\Maintenance\\' => __DIR__ . '/../maintenance/includes/',
	'MediaWiki\\Page\\' => __DIR__ . '/page/',
	'MediaWiki\\Parser\\' => __DIR__ . '/parser/',
	'MediaWiki\\Password\\' => __DIR__ . '/password/',
	'MediaWiki\\PoolCounter\\' => __DIR__ . '/poolcounter/',
	'MediaWiki\\Preferences\\' => __DIR__ . '/preferences/',
	'MediaWiki\\Profiler\\' => __DIR__ . '/profiler/',
	'MediaWiki\\RCFeed\\' => __DIR__ . '/recentchanges/RCFeed/',
	'MediaWiki\\RecentChanges\\' => __DIR__ . '/recentchanges/',
	'MediaWiki\\Registration\\' => __DIR__ . '/registration/',
	'MediaWiki\\RevisionList\\' => __DIR__ . '/revisionlist/',
	'MediaWiki\\Search\\' => __DIR__ . '/search/',
	'MediaWiki\\Search\\SearchWidgets\\' => __DIR__ . '/search/searchwidgets/',
	'MediaWiki\\Session\\' => __DIR__ . '/session/',
	'MediaWiki\\Shell\\' => __DIR__ . '/shell/',
	'MediaWiki\\Site\\' => __DIR__ . '/site/',
	'MediaWiki\\Skin\\' => __DIR__ . '/skins/',
	'MediaWiki\\Sparql\\' => __DIR__ . '/sparql/',
	'MediaWiki\\SpecialPage\\' => __DIR__ . '/specialpage/',
	'MediaWiki\\Specials\\' => __DIR__ . '/specials/',
	'MediaWiki\\Specials\\Contribute\\' => __DIR__ . '/specials/Contribute/',
	'MediaWiki\\Specials\\Redirects\\' => __DIR__ . '/specials/redirects/',
	'MediaWiki\\Telemetry\\' => __DIR__ . '/telemetry/',
	'MediaWiki\\Tidy\\' => __DIR__ . '/tidy/',
	'MediaWiki\\Title\\' => __DIR__ . '/title/',
	'MediaWiki\\User\\' => __DIR__ . '/user/',
	'MediaWiki\\Utils\\' => __DIR__ . '/utils/',
	'MediaWiki\\Watchlist\\' => __DIR__ . '/watchlist/',
	'MediaWiki\\Widget\\' => __DIR__ . '/widget/',
	'MediaWiki\\Xml\\' => __DIR__ . '/xml/',
	'Wikimedia\\' => __DIR__ . '/libs/',
	'Wikimedia\\Composer\\' => __DIR__ . '/libs/composer/',
	'Wikimedia\\DependencyStore\\' => __DIR__ . '/ResourceLoader/dependencystore/',
	'Wikimedia\\EventRelayer\\' => __DIR__ . '/libs/eventrelayer/',
	'Wikimedia\\FileBackend\\' => __DIR__ . '/libs/filebackend/',
	'Wikimedia\\FileBackend\\FileIteration\\' => __DIR__ . '/libs/filebackend/fileiteration/',
	'Wikimedia\\FileBackend\\FileOpHandle\\' => __DIR__ . '/libs/filebackend/fileophandle/',
	'Wikimedia\\FileBackend\\FileOps\\' => __DIR__ . '/libs/filebackend/fileop/',
	'Wikimedia\\FileBackend\\FSFile\\' => __DIR__ . '/libs/filebackend/fsfile/',
	'Wikimedia\\Http\\' => __DIR__ . '/libs/http/',
	'Wikimedia\\LightweightObjectStore\\' => __DIR__ . '/libs/objectcache/utils/',
	'Wikimedia\\Mime\\' => __DIR__ . '/libs/mime/',
	'Wikimedia\\ObjectCache\\' => __DIR__ . '/libs/objectcache/',
	'Wikimedia\\Rdbms\\Database\\' => __DIR__ . '/libs/rdbms/database/',
	'Wikimedia\\Rdbms\\Platform\\' => __DIR__ . '/libs/rdbms/platform/',
	'Wikimedia\\Rdbms\\Replication\\' => __DIR__ . '/libs/rdbms/database/replication/',
	'Wikimedia\\Telemetry\\' => __DIR__ . '/libs/telemetry/',
	'Wikimedia\\UUID\\' => __DIR__ . '/libs/uuid/',
	];

	/**
	* @var string[] Namespace (ends with \) => Path (ends with /)
	*/
	private static $psr4Namespaces = [];

	/**
	* @var string[] Class => File
	*/
	private static $classFiles = [];

	/**
	* Register a directory to load the classes of a given namespace from,
	* per PSR4.
	*
	* @see <https://www.php-fig.org/psr/psr-4/>
	* @since 1.39
	* @param string[] $dirs a map of namespace (ends with \) to path (ends with /)
	*/
	public static function registerNamespaces( array $dirs ): void {
	self::$psr4Namespaces += $dirs;
	}

	/**
	* Register a file to load the given class from.
	* @since 1.39
	*
	* @param string[] $files a map of qualified class names to file names
	*/
	public static function registerClasses( array $files ): void {
	self::$classFiles += $files;
	}

	/**
	* Load a file that declares classes, functions, or constants.
	* The file will be loaded immediately using require_once in function scope.
	*
	* @note The file to be loaded MUST NOT set global variables or otherwise
	* affect the global state. It MAY however use conditionals to determine
	* what to declare and how, e.g. to provide polyfills.
	*
	* @note The file to be loaded MUST NOT assume that MediaWiki has been
	* initialized. In particular, it MUST NOT access configuration variables
	* or MediaWikiServices.
	*
	* @since 1.39
	*
	* @param string $file the path of the file to load.
	*/
	public static function loadFile( string $file ): void {
	require_once $file;
	}

	/**
	* Batch version of loadFile()
	*
	* @see loadFile()
	*
	* @since 1.39
	*
	* @param string[] $files the paths of the files to load.
	*/
	public static function loadFiles( array $files ): void {
	foreach ( $files as $f ) {
	self::loadFile( $f );
	}
	}

	/**
	* Find the file containing the given class.
	*
	* @param class-string $className Name of class we're looking for.
	* @return string\|null The path containing the class, not null if not found
	*/
	public static function find( $className ): ?string {
	global $wgAutoloadLocalClasses, $wgAutoloadClasses;

	// NOTE: $wgAutoloadClasses is supported for compatibility with old-style extension
	// registration files.

	$filename = $wgAutoloadLocalClasses[$className] ??
	self::$classFiles[$className] ??
	$wgAutoloadClasses[$className] ??
	false;

	if ( !$filename && str_contains( $className, '\\' ) ) {
	// This class is namespaced, so look in the namespace map
	$prefix = $className;
	// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
	while ( ( $pos = strrpos( $prefix, '\\' ) ) !== false ) {
	// Check to see if this namespace prefix is in the map
	$prefix = substr( $className, 0, $pos + 1 );
	if ( isset( self::$psr4Namespaces[$prefix] ) ) {
	$relativeClass = substr( $className, $pos + 1 );
	// Build the expected filename, and see if it exists
	$file = self::$psr4Namespaces[$prefix] .
	strtr( $relativeClass, '\\', '/' ) .
	'.php';
	if ( is_file( $file ) ) {
	$filename = $file;
	break;
	}
	}

	// Remove trailing separator for next iteration
	$prefix = rtrim( $prefix, '\\' );
	}
	}

	if ( !$filename ) {
	// Class not found; let the next autoloader try to find it
	return null;
	}

	// Make an absolute path, this improves performance by avoiding some stat calls
	// Optimisation: use string offset access instead of substr
	if ( $filename[0] !== '/' && $filename[1] !== ':' ) {
	$filename = __DIR__ . '/../' . $filename;
	}

	return $filename;
	}

	/**
	* autoload - take a class name and attempt to load it
	*
	* @param class-string $className Name of class we're looking for.
	*/
	public static function autoload( $className ) {
	$filename = self::find( $className );

	if ( $filename !== null ) {
	require_once $filename;
	}
	}

	///// Methods used during testing //////////////////////////////////////////////
	private static function assertTesting( string $method ): void {
	if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
	throw new LogicException( "$method is not supported outside phpunit tests!" );
	}
	}

	/**
	* Returns a map of class names to file paths for testing.
	* @note Will throw if called outside of phpunit tests!
	* @return string[]
	*/
	public static function getClassFiles(): array {
	global $wgAutoloadLocalClasses, $wgAutoloadClasses;

	self::assertTesting( __METHOD__ );

	// NOTE: ensure the order of preference is the same as used by find().
	return array_merge(
	$wgAutoloadClasses,
	self::$classFiles,
	$wgAutoloadLocalClasses
	);
	}

	/**
	* Returns a map of namespace names to directories, per PSR4.
	* @note Will throw if called outside of phpunit tests!
	* @return string[]
	*/
	public static function getNamespaceDirectories(): array {
	self::assertTesting( __METHOD__ );
	return self::$psr4Namespaces;
	}

	/**
	* Returns an array representing the internal state of Autoloader,
	* so it can be remembered and later restored during testing.
	* @internal
	* @note Will throw if called outside of phpunit tests!
	* @return array
	*/
	public static function getState(): array {
	self::assertTesting( __METHOD__ );
	return [
	'classFiles' => self::$classFiles,
	'psr4Namespaces' => self::$psr4Namespaces,
	];
	}

	/**
	* Returns an array representing the internal state of Autoloader,
	* so it can be remembered and later restored during testing.
	* @internal
	* @note Will throw if called outside of phpunit tests!
	*
	* @param array $state A state array returned by getState().
	*/
	public static function restoreState( $state ): void {
	self::assertTesting( __METHOD__ );

	self::$classFiles = $state['classFiles'];
	self::$psr4Namespaces = $state['psr4Namespaces'];
	}

	}

	spl_autoload_register( [ 'AutoLoader', 'autoload' ] );

	// Load composer's autoloader if present
	if ( is_readable( __DIR__ . '/../vendor/autoload.php' ) ) {
	require_once __DIR__ . '/../vendor/autoload.php';
	} elseif ( file_exists( __DIR__ . '/../vendor/autoload.php' ) ) {
	die( __DIR__ . '/../vendor/autoload.php exists but is not readable' );
	}

File Metadata

Mime Type: text/x-php
Expires: Fri, Jul 3, 21:16 (22 h, 6 m)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 9e/54/adfde7b670fdbfbd80bc7f4a0a4f
Default Alt Text: AutoLoader.php (12 KB)

AutoLoader.phpNo OneTemporaryActions

AutoLoader.phpView Options

File Metadata

Event Timeline

AutoLoader.php
No OneTemporary
Actions

AutoLoader.php
View Options