47 parent::__construct( $queryModule->
getMain(), $moduleName, $paramPrefix );
48 $this->mQueryModule = $queryModule;
110 if ( is_null( $this->mDb ) ) {
111 $this->mDb = $this->
getQuery()->getDB();
126 $this->mDb = $this->
getQuery()->getNamedDB(
$name, $db, $groups );
135 return $this->
getQuery()->getPageSet();
153 $this->join_conds = [];
164 if ( !is_null( $alias ) ) {
167 $this->tables = array_merge( $this->tables,
$tables );
169 if ( !is_null( $alias ) ) {
170 $this->tables[$alias] =
$tables;
189 $this->join_conds = array_merge( $this->join_conds,
$join_conds );
197 if ( is_array(
$value ) ) {
198 $this->fields = array_merge( $this->fields,
$value );
232 if ( is_array(
$value ) ) {
236 $this->where = array_merge( $this->where,
$value );
268 $this->where[$field] =
$value;
285 $isDirNewer = ( $dir ===
'newer' );
286 $after = ( $isDirNewer ?
'>=' :
'<=' );
287 $before = ( $isDirNewer ?
'<=' :
'>=' );
288 $db = $this->
getDB();
290 if ( !is_null( $start ) ) {
291 $this->
addWhere( $field . $after . $db->addQuotes( $start ) );
294 if ( !is_null( $end ) ) {
295 $this->
addWhere( $field . $before . $db->addQuotes( $end ) );
299 $order = $field . ( $isDirNewer ?
'' :
' DESC' );
301 $optionOrderBy = isset( $this->
options[
'ORDER BY'] )
304 $optionOrderBy[] = $order;
305 $this->
addOption(
'ORDER BY', $optionOrderBy );
320 $db = $this->
getDB();
322 $db->timestampOrNull( $start ), $db->timestampOrNull( $end ),
$sort );
332 if ( is_null(
$value ) ) {
356 protected function select( $method, $extraQuery = [],
array &$hookData =
null ) {
359 isset( $extraQuery[
'tables'] ) ? (
array)$extraQuery[
'tables'] : []
363 isset( $extraQuery[
'fields'] ) ? (
array)$extraQuery[
'fields'] : []
367 isset( $extraQuery[
'where'] ) ? (
array)$extraQuery[
'where'] : []
371 isset( $extraQuery[
'options'] ) ? (
array)$extraQuery[
'options'] : []
375 isset( $extraQuery[
'join_conds'] ) ? (
array)$extraQuery[
'join_conds'] : []
378 if ( $hookData !==
null ) {
379 Hooks::run(
'ApiQueryBaseBeforeQuery',
386 if ( $hookData !==
null ) {
387 Hooks::run(
'ApiQueryBaseAfterQuery', [ $this,
$res, &$hookData ] );
407 return Hooks::run(
'ApiQueryBaseProcessRow', [ $this, $row, &$data, &$hookData ] );
416 $db = $this->
getDB();
418 if ( is_null( $protocol ) ) {
419 $protocol =
'http://';
429 return 'el_index ' . $db->buildLike( $likeQuery );
430 } elseif ( !is_null( $protocol ) ) {
431 return 'el_index ' . $db->buildLike(
"$protocol", $db->anyString() );
447 'ipblocks' => [
'LEFT JOIN',
'ipb_user=user_id' ],
452 if ( $showBlockInfo ) {
461 $this->
addTables( $commentQuery[
'tables'] );
462 $this->
addFields( $commentQuery[
'fields'] );
467 if ( !$this->
getUser()->isAllowed(
'hideuser' ) ) {
468 $this->
addWhere(
'ipb_deleted = 0 OR ipb_deleted IS NULL' );
487 $arr[$prefix .
'ns'] = intval(
$title->getNamespace() );
488 $arr[$prefix .
'title'] =
$title->getPrefixedText();
501 return $result->addValue( [
'query',
'pages', intval( $pageId ) ],
515 if ( is_null( $elemname ) ) {
519 $fit =
$result->addValue( [
'query',
'pages', $pageId,
524 $result->addIndexedTagName( [
'query',
'pages', $pageId,
550 $t = Title::makeTitleSafe( $namespace, $titlePart .
'x' );
551 if ( !
$t ||
$t->hasFragment() ) {
555 if ( $namespace !=
$t->getNamespace() ||
$t->isExternal() ) {
564 return substr(
$t->getDBkey(), 0, -1 );
576 $t = Title::newFromText( $titlePart .
'x', $defaultNamespace );
577 if ( !
$t ||
$t->hasFragment() ||
$t->isExternal() ) {
582 return [
$t->getNamespace(), substr(
$t->getDBkey(), 0, -1 ) ];
590 return (
bool)preg_match(
'/^[a-f0-9]{40}$/', $hash );
598 return (
bool)preg_match(
'/^[a-z0-9]{31}$/', $hash );
607 return $this->
getUser()->isAllowedAny(
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
This abstract class implements many basic API functions, and is the base of all API classes.
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
getMain()
Get the main module.
getResult()
Get the result object.
getModuleName()
Get the name of the module being executed by this instance.
getContinuationManager()
Get the continuation manager.
This is a base class for all Query modules.
selectNamedDB( $name, $db, $groups)
Selects the query database connection with the given name.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
validateSha1Base36Hash( $hash)
resetQueryParams()
Blank the internal arrays with query parameters.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
prepareUrlQuerySearchString( $query=null, $protocol=null)
addPageSubItems( $pageId, $data)
Add a sub-element under the page element with the given page ID.
addFields( $value)
Add a set of fields to select to the internal array.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
getDB()
Get the Query database connection (read-only)
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
requestExtraData( $pageSet)
Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName...
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
getQuery()
Get the main Query module.
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
getPageSet()
Get the PageSet object to work on.
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
__construct(ApiQuery $queryModule, $moduleName, $paramPrefix='')
prefixedTitlePartToKey( $titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a namespace constant and dbkey.
showHiddenUsersAddBlockInfo( $showBlockInfo)
Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block in...
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
This is the main query class.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
getUser()
Get the User object.
static makeLikeArray( $filterEntry, $protocol='http://')
Make an array to be used for calls to Database::buildLike(), which will match the specified string.
static keepOneWildcard( $arr)
Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder.
the array() calling protocol came about after MediaWiki 1.4rc1.
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 '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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
namespace and then decline to actually register it file or subcat img or subcat $title
Allows to change the fields on the form that will be generated $name
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
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