MediaWiki  master
LinkBatch.php
Go to the documentation of this file.
1 <?php
27 
34 class LinkBatch {
38  public $data = [];
39 
43  protected $caller;
44 
48  public function __construct( $arr = [] ) {
49  foreach ( $arr as $item ) {
50  $this->addObj( $item );
51  }
52  }
53 
62  public function setCaller( $caller ) {
63  $this->caller = $caller;
64 
65  return $this;
66  }
67 
71  public function addObj( $linkTarget ) {
72  if ( is_object( $linkTarget ) ) {
73  $this->add( $linkTarget->getNamespace(), $linkTarget->getDBkey() );
74  } else {
75  wfDebug( "Warning: LinkBatch::addObj got invalid LinkTarget object\n" );
76  }
77  }
78 
83  public function add( $ns, $dbkey ) {
84  if ( $ns < 0 || $dbkey === '' ) {
85  return; // T137083
86  }
87  if ( !array_key_exists( $ns, $this->data ) ) {
88  $this->data[$ns] = [];
89  }
90 
91  $this->data[$ns][strtr( $dbkey, ' ', '_' )] = 1;
92  }
93 
100  public function setArray( $array ) {
101  $this->data = $array;
102  }
103 
109  public function isEmpty() {
110  return $this->getSize() == 0;
111  }
112 
118  public function getSize() {
119  return count( $this->data );
120  }
121 
127  public function execute() {
128  $linkCache = MediaWikiServices::getInstance()->getLinkCache();
129 
130  return $this->executeInto( $linkCache );
131  }
132 
140  protected function executeInto( &$cache ) {
141  $res = $this->doQuery();
142  $this->doGenderQuery();
143  $ids = $this->addResultToCache( $cache, $res );
144 
145  return $ids;
146  }
147 
158  public function addResultToCache( $cache, $res ) {
159  if ( !$res ) {
160  return [];
161  }
162 
163  $titleFormatter = MediaWikiServices::getInstance()->getTitleFormatter();
164  // For each returned entry, add it to the list of good links, and remove it from $remaining
165 
166  $ids = [];
167  $remaining = $this->data;
168  foreach ( $res as $row ) {
169  $title = new TitleValue( (int)$row->page_namespace, $row->page_title );
170  $cache->addGoodLinkObjFromRow( $title, $row );
171  $pdbk = $titleFormatter->getPrefixedDBkey( $title );
172  $ids[$pdbk] = $row->page_id;
173  unset( $remaining[$row->page_namespace][$row->page_title] );
174  }
175 
176  // The remaining links in $data are bad links, register them as such
177  foreach ( $remaining as $ns => $dbkeys ) {
178  foreach ( $dbkeys as $dbkey => $unused ) {
179  $title = new TitleValue( (int)$ns, (string)$dbkey );
180  $cache->addBadLinkObj( $title );
181  $pdbk = $titleFormatter->getPrefixedDBkey( $title );
182  $ids[$pdbk] = 0;
183  }
184  }
185 
186  return $ids;
187  }
188 
193  public function doQuery() {
194  if ( $this->isEmpty() ) {
195  return false;
196  }
197 
198  // This is similar to LinkHolderArray::replaceInternal
199  $dbr = wfGetDB( DB_REPLICA );
200  $table = 'page';
201  $fields = array_merge(
203  [ 'page_namespace', 'page_title' ]
204  );
205 
206  $conds = $this->constructSet( 'page', $dbr );
207 
208  // Do query
209  $caller = __METHOD__;
210  if ( strval( $this->caller ) !== '' ) {
211  $caller .= " (for {$this->caller})";
212  }
213  $res = $dbr->select( $table, $fields, $conds, $caller );
214 
215  return $res;
216  }
217 
223  public function doGenderQuery() {
224  if ( $this->isEmpty() ) {
225  return false;
226  }
227  $services = MediaWikiServices::getInstance();
228 
229  if ( !$services->getContentLanguage()->needsGenderDistinction() ) {
230  return false;
231  }
232 
233  $genderCache = $services->getGenderCache();
234  $genderCache->doLinkBatch( $this->data, $this->caller );
235 
236  return true;
237  }
238 
246  public function constructSet( $prefix, $db ) {
247  return $db->makeWhereFrom2d( $this->data, "{$prefix}_namespace", "{$prefix}_title" );
248  }
249 }
setCaller( $caller)
Use ->setCaller( METHOD ) to indicate which code is using this class.
Definition: LinkBatch.php:62
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
setArray( $array)
Set the link list to a given 2-d array First key is the namespace, second is the DB key...
Definition: LinkBatch.php:100
add( $ns, $dbkey)
Definition: LinkBatch.php:83
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
addResultToCache( $cache, $res)
Add a ResultWrapper containing IDs and titles to a LinkCache object.
Definition: LinkBatch.php:158
doGenderQuery()
Do (and cache) {{GENDER:...}} information for userpages in this LinkBatch.
Definition: LinkBatch.php:223
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 MediaWikiServices
Definition: injection.txt:23
addObj( $linkTarget)
Definition: LinkBatch.php:71
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
isEmpty()
Returns true if no pages have been added, false otherwise.
Definition: LinkBatch.php:109
__construct( $arr=[])
Definition: LinkBatch.php:48
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2217
$res
Definition: database.txt:21
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$caller
For debugging which method is using this class.
Definition: LinkBatch.php:43
constructSet( $prefix, $db)
Construct a WHERE clause which will match all the given titles.
Definition: LinkBatch.php:246
doQuery()
Perform the existence test query, return a ResultWrapper with page_id fields.
Definition: LinkBatch.php:193
$cache
Definition: mcc.php:33
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
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
Definition: distributors.txt:9
static getSelectFields()
Fields that LinkCache needs to select.
Definition: LinkCache.php:206
$data
2-d array, first index namespace, second index dbkey, value arbitrary
Definition: LinkBatch.php:38
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
execute()
Do the query and add the results to the LinkCache object.
Definition: LinkBatch.php:127
executeInto(&$cache)
Do the query and add the results to a given LinkCache object Return an array mapping PDBK to ID...
Definition: LinkBatch.php:140
const DB_REPLICA
Definition: defines.php:25
getSize()
Returns the size of the batch.
Definition: LinkBatch.php:118