MediaWiki  1.28.0
LinkBatch.php
Go to the documentation of this file.
1 <?php
25 
32 class LinkBatch {
36  public $data = [];
37 
41  protected $caller;
42 
47  public function __construct( $arr = [] ) {
48  foreach ( $arr as $item ) {
49  $this->addObj( $item );
50  }
51  }
52 
60  public function setCaller( $caller ) {
61  $this->caller = $caller;
62  }
63 
67  public function addObj( $linkTarget ) {
68  if ( is_object( $linkTarget ) ) {
69  $this->add( $linkTarget->getNamespace(), $linkTarget->getDBkey() );
70  } else {
71  wfDebug( "Warning: LinkBatch::addObj got invalid LinkTarget object\n" );
72  }
73  }
74 
79  public function add( $ns, $dbkey ) {
80  if ( $ns < 0 || $dbkey === '' ) {
81  return; // T137083
82  }
83  if ( !array_key_exists( $ns, $this->data ) ) {
84  $this->data[$ns] = [];
85  }
86 
87  $this->data[$ns][strtr( $dbkey, ' ', '_' )] = 1;
88  }
89 
96  public function setArray( $array ) {
97  $this->data = $array;
98  }
99 
105  public function isEmpty() {
106  return $this->getSize() == 0;
107  }
108 
114  public function getSize() {
115  return count( $this->data );
116  }
117 
123  public function execute() {
124  $linkCache = MediaWikiServices::getInstance()->getLinkCache();
125 
126  return $this->executeInto( $linkCache );
127  }
128 
136  protected function executeInto( &$cache ) {
137  $res = $this->doQuery();
138  $this->doGenderQuery();
139  $ids = $this->addResultToCache( $cache, $res );
140 
141  return $ids;
142  }
143 
154  public function addResultToCache( $cache, $res ) {
155  if ( !$res ) {
156  return [];
157  }
158 
159  $titleFormatter = MediaWikiServices::getInstance()->getTitleFormatter();
160  // For each returned entry, add it to the list of good links, and remove it from $remaining
161 
162  $ids = [];
163  $remaining = $this->data;
164  foreach ( $res as $row ) {
165  $title = new TitleValue( (int)$row->page_namespace, $row->page_title );
166  $cache->addGoodLinkObjFromRow( $title, $row );
167  $pdbk = $titleFormatter->getPrefixedDBkey( $title );
168  $ids[$pdbk] = $row->page_id;
169  unset( $remaining[$row->page_namespace][$row->page_title] );
170  }
171 
172  // The remaining links in $data are bad links, register them as such
173  foreach ( $remaining as $ns => $dbkeys ) {
174  foreach ( $dbkeys as $dbkey => $unused ) {
175  $title = new TitleValue( (int)$ns, (string)$dbkey );
176  $cache->addBadLinkObj( $title );
177  $pdbk = $titleFormatter->getPrefixedDBkey( $title );
178  $ids[$pdbk] = 0;
179  }
180  }
181 
182  return $ids;
183  }
184 
189  public function doQuery() {
190  if ( $this->isEmpty() ) {
191  return false;
192  }
193 
194  // This is similar to LinkHolderArray::replaceInternal
195  $dbr = wfGetDB( DB_REPLICA );
196  $table = 'page';
197  $fields = array_merge(
199  [ 'page_namespace', 'page_title' ]
200  );
201 
202  $conds = $this->constructSet( 'page', $dbr );
203 
204  // Do query
205  $caller = __METHOD__;
206  if ( strval( $this->caller ) !== '' ) {
207  $caller .= " (for {$this->caller})";
208  }
209  $res = $dbr->select( $table, $fields, $conds, $caller );
210 
211  return $res;
212  }
213 
219  public function doGenderQuery() {
220  if ( $this->isEmpty() ) {
221  return false;
222  }
223 
225  if ( !$wgContLang->needsGenderDistinction() ) {
226  return false;
227  }
228 
229  $genderCache = MediaWikiServices::getInstance()->getGenderCache();
230  $genderCache->doLinkBatch( $this->data, $this->caller );
231 
232  return true;
233  }
234 
242  public function constructSet( $prefix, $db ) {
243  return $db->makeWhereFrom2d( $this->data, "{$prefix}_namespace", "{$prefix}_title" );
244  }
245 }
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
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:36
doGenderQuery()
Do (and cache) {{GENDER:...}} information for userpages in this LinkBatch.
Definition: LinkBatch.php:219
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
setCaller($caller)
Use ->setCaller( METHOD ) to indicate which code is using this class.
Definition: LinkBatch.php:60
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
__construct($arr=[])
LinkBatch constructor.
Definition: LinkBatch.php:47
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:32
isEmpty()
Returns true if no pages have been added, false otherwise.
Definition: LinkBatch.php:105
constructSet($prefix, $db)
Construct a WHERE clause which will match all the given titles.
Definition: LinkBatch.php:242
$res
Definition: database.txt:21
$caller
For debugging which method is using this class.
Definition: LinkBatch.php:41
doQuery()
Perform the existence test query, return a ResultWrapper with page_id fields.
Definition: LinkBatch.php:189
$cache
Definition: mcc.php:33
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
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
addResultToCache($cache, $res)
Add a ResultWrapper containing IDs and titles to a LinkCache object.
Definition: LinkBatch.php:154
static getSelectFields()
Fields that LinkCache needs to select.
Definition: LinkCache.php:210
$data
2-d array, first index namespace, second index dbkey, value arbitrary
Definition: LinkBatch.php:36
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:123
executeInto(&$cache)
Do the query and add the results to a given LinkCache object Return an array mapping PDBK to ID...
Definition: LinkBatch.php:136
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
add($ns, $dbkey)
Definition: LinkBatch.php:79
const DB_REPLICA
Definition: defines.php:22
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:96
addObj($linkTarget)
Definition: LinkBatch.php:67
getSize()
Returns the size of the batch.
Definition: LinkBatch.php:114