Go to the documentation of this file.
67 if ( !is_array( $flags ) ) {
72 if ( in_array(
'local', $flags ) ) {
73 $this->variableName =
'wgAutoloadLocalClasses';
100 $ns = rtrim( $ns,
'\\' ) .
'\\';
101 $this->psr4Namespaces[$ns] = rtrim( self::normalizePathSeparator(
$path ),
'/' );
112 foreach ( $this->excludePaths
as $dir ) {
113 if ( strpos(
$path, $dir ) === 0 ) {
132 throw new \Exception(
"Invalid path: $inputPath" );
134 $len = strlen( $this->basepath );
135 if ( substr(
$path, 0, $len ) !== $this->basepath ) {
136 throw new \Exception(
"Path is not within basepath: $inputPath" );
138 $shortpath = substr(
$path, $len );
139 $this->overrides[$fqcn] = $shortpath;
151 $len = strlen( $this->basepath );
152 if ( substr( $inputPath, 0, $len ) !== $this->basepath ) {
153 throw new \Exception(
"Path is not within basepath: $inputPath" );
158 $result = $this->collector->getClasses(
159 file_get_contents( $inputPath )
164 $parts = explode(
'\\', $class );
165 for ( $i =
count( $parts ) - 1; $i > 0; $i-- ) {
166 $ns = implode(
'\\', array_slice( $parts, 0, $i ) ) .
'\\';
167 if ( isset( $this->psr4Namespaces[$ns] ) ) {
168 $expectedPath = $this->psr4Namespaces[$ns] .
'/'
169 . implode(
'/', array_slice( $parts, $i ) )
171 if ( $inputPath === $expectedPath ) {
181 $shortpath = substr( $inputPath, $len );
191 $it =
new RecursiveDirectoryIterator(
192 self::normalizePathSeparator( realpath( $dir ) ) );
193 $it =
new RecursiveIteratorIterator( $it );
196 $ext = pathinfo(
$path, PATHINFO_EXTENSION );
198 if (
$ext ===
'php' ||
$ext ===
'inc' ) {
213 $key =
'AutoloadClasses';
215 unset( $json[$key] );
219 foreach ( $contained
as $fqcn ) {
221 $json[$key][$fqcn] = substr(
$path, 1 );
224 foreach ( $this->overrides
as $path => $fqcn ) {
226 $json[$key][$fqcn] = substr(
$path, 1 );
230 ksort( $json[$key] );
249 $format =
"%s => __DIR__ . %s,";
251 $exportedPath = var_export(
$path,
true );
252 foreach ( $contained
as $fqcn ) {
255 var_export( $fqcn,
true ),
261 foreach ( $this->overrides
as $fqcn =>
$path ) {
264 var_export( $fqcn,
true ),
265 var_export(
$path,
true )
274 if ( $this->variableName ===
'wgAutoloadClasses' ) {
285 global \${$this->variableName};
287 \${$this->variableName} {$op} [
302 public function getAutoload( $commandName =
'AutoloadGenerator' ) {
308 if (
$fileinfo[
'type'] === self::FILETYPE_JSON ) {
325 'filename' => $this->basepath .
'/autoload.php',
328 if ( file_exists( $this->basepath .
'/extension.json' ) ) {
330 'filename' => $this->basepath .
'/extension.json',
333 } elseif ( file_exists( $this->basepath .
'/skin.json' ) ) {
335 'filename' => $this->basepath .
'/skin.json',
350 return str_replace(
'\\',
'/',
$path );
363 foreach ( [
'includes',
'languages',
'maintenance',
'mw-config' ]
as $dir ) {
364 $this->
readDir( $this->basepath .
'/' . $dir );
366 foreach ( glob( $this->basepath .
'/*.php' )
as $file ) {
407 $this->
namespace = '';
409 $this->startToken =
null;
413 foreach ( token_get_all(
$code )
as $token ) {
414 if ( $this->startToken ===
null ) {
430 if ( is_string( $token ) ) {
435 switch ( $token[0] ) {
442 $this->startToken = $token;
445 if ( $token[1] ===
'class_alias' ) {
446 $this->startToken = $token;
458 switch ( $this->startToken[0] ) {
462 $this->startToken =
null;
466 if ( !is_array( $token ) || $token[0] !== T_WHITESPACE ) {
467 $this->startToken =
null;
471 if ( $token ===
';' || $token ===
'{' ) {
474 $this->tokens[] = $token;
479 if ( $this->alias !==
null ) {
498 if ( $token ===
'(' ) {
500 $this->alias = [
'target' =>
false,
'name' =>
false ];
501 } elseif ( $token ===
',' ) {
503 if ( $this->alias[
'target'] ===
false ) {
504 $this->alias[
'target'] =
true;
506 } elseif ( is_array( $token ) && $token[0] === T_CONSTANT_ENCAPSED_STRING ) {
507 if ( $this->alias[
'target'] ===
true ) {
510 $this->alias[
'name'] = substr( $token[1], 1, -1 );
512 } elseif ( $token ===
')' ) {
514 $this->
classes[] = $this->alias[
'name'];
516 $this->startToken =
null;
517 } elseif ( !is_array( $token ) || (
518 $token[0] !== T_STRING &&
519 $token[0] !== T_DOUBLE_COLON &&
520 $token[0] !== T_CLASS &&
521 $token[0] !== T_WHITESPACE
525 $this->startToken =
null;
533 $this->tokens[] = $token;
534 if ( is_array( $token ) && $token[0] === T_STRING ) {
548 foreach ( $this->tokens
as $token ) {
549 $content[] = is_string( $token ) ? $token : $token[1];
553 $this->startToken =
null;
555 return trim( implode(
'',
$content ),
" \n\t" );
setPsr4Namespaces(array $namespaces)
Set PSR4 namespaces.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
processing should stop and the error should be shown to the user * false
implodeTokens()
Returns the string representation of the tokens within the current expect sequence and resets the seq...
initMediaWikiDefault()
Initialize the source files and directories which are used for the MediaWiki default autoloader in {m...
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
namespace and then decline to actually register it & $namespaces
forceClassPath( $fqcn, $inputPath)
Force a class to be autoloaded from a specific path, regardless of where or if it was detected.
tryBeginExpect( $token)
Determine if $token begins the next expect sequence.
static normalizePathSeparator( $path)
Ensure that Unix-style path separators ("/") are used in the path.
Accepts a list of files and directories to search for php files and generates $wgAutoloadLocalClasses...
string $variableName
The global variable to write output to.
Reads PHP code and returns the FQCN of every class defined within it.
array $classes
List of FQCN detected in this pass.
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
shouldExclude( $path)
Whether the file should be excluded.
array $classes
Map of file shortpath to list of FQCN detected within file.
setExcludePaths(array $paths)
Directories that should be excluded.
array $tokens
List of tokens that are members of the current expect sequence.
array $overrides
Map of FQCN to relative path(from self::$basepath)
__construct( $basepath, $flags=[])
string[] $psr4Namespaces
Configured PSR4 namespaces.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
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 it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
string[] $excludePaths
Directories that should be excluded.
string $namespace
Current namespace.
generateJsonAutoload( $filename)
Updates the AutoloadClasses field at the given filename.
getAutoload( $commandName='AutoloadGenerator')
Returns all known classes as a string, which can be used to put into a target file (e....
this hook is for auditing only RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those classes
string $basepath
Root path of the project being scanned for classes.
generatePHPAutoload( $commandName, $filename)
Generates a PHP file setting up autoload information.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
array $alias
Class alias with target/name fields.
getTargetFileinfo()
Returns the filename of the extension.json of skin.json, if there's any, or otherwise the path to the...
tryEndExpect( $token)
Accepts the next token in an expect sequence.
array $startToken
Token from token_get_all() that started an expect sequence.
if(!is_readable( $file)) $ext
ClassCollector $collector
Helper class extracts class names from php files.