MediaWiki  1.30.0
PageProps.php
Go to the documentation of this file.
1 <?php
22 use Wikimedia\ScopedCallback;
23 
29 class PageProps {
30 
34  private static $instance;
35 
50  public static function overrideInstance( PageProps $store = null ) {
51  if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
52  throw new MWException(
53  'Cannot override ' . __CLASS__ . 'default instance in operation.'
54  );
55  }
56  $previousValue = self::$instance;
57  self::$instance = $store;
58  return new ScopedCallback( function () use ( $previousValue ) {
59  self::$instance = $previousValue;
60  } );
61  }
62 
66  public static function getInstance() {
67  if ( self::$instance === null ) {
68  self::$instance = new self();
69  }
70  return self::$instance;
71  }
72 
74  const CACHE_TTL = 10; // integer; TTL in seconds
75  const CACHE_SIZE = 100; // integer; max cached pages
76 
78  private $cache = null;
79 
83  private function __construct() {
84  $this->cache = new ProcessCacheLRU( self::CACHE_SIZE );
85  }
86 
91  public function ensureCacheSize( $size ) {
92  if ( $this->cache->getSize() < $size ) {
93  $this->cache->resize( $size );
94  }
95  }
96 
115  public function getProperties( $titles, $propertyNames ) {
116  if ( is_array( $propertyNames ) ) {
117  $gotArray = true;
118  } else {
119  $propertyNames = [ $propertyNames ];
120  $gotArray = false;
121  }
122 
123  $values = [];
124  $goodIDs = $this->getGoodIDs( $titles );
125  $queryIDs = [];
126  foreach ( $goodIDs as $pageID ) {
127  foreach ( $propertyNames as $propertyName ) {
128  $propertyValue = $this->getCachedProperty( $pageID, $propertyName );
129  if ( $propertyValue === false ) {
130  $queryIDs[] = $pageID;
131  break;
132  } else {
133  if ( $gotArray ) {
134  $values[$pageID][$propertyName] = $propertyValue;
135  } else {
136  $values[$pageID] = $propertyValue;
137  }
138  }
139  }
140  }
141 
142  if ( $queryIDs ) {
143  $dbr = wfGetDB( DB_REPLICA );
144  $result = $dbr->select(
145  'page_props',
146  [
147  'pp_page',
148  'pp_propname',
149  'pp_value'
150  ],
151  [
152  'pp_page' => $queryIDs,
153  'pp_propname' => $propertyNames
154  ],
155  __METHOD__
156  );
157 
158  foreach ( $result as $row ) {
159  $pageID = $row->pp_page;
160  $propertyName = $row->pp_propname;
161  $propertyValue = $row->pp_value;
162  $this->cacheProperty( $pageID, $propertyName, $propertyValue );
163  if ( $gotArray ) {
164  $values[$pageID][$propertyName] = $propertyValue;
165  } else {
166  $values[$pageID] = $propertyValue;
167  }
168  }
169  }
170 
171  return $values;
172  }
173 
187  public function getAllProperties( $titles ) {
188  $values = [];
189  $goodIDs = $this->getGoodIDs( $titles );
190  $queryIDs = [];
191  foreach ( $goodIDs as $pageID ) {
192  $pageProperties = $this->getCachedProperties( $pageID );
193  if ( $pageProperties === false ) {
194  $queryIDs[] = $pageID;
195  } else {
196  $values[$pageID] = $pageProperties;
197  }
198  }
199 
200  if ( $queryIDs != [] ) {
201  $dbr = wfGetDB( DB_REPLICA );
202  $result = $dbr->select(
203  'page_props',
204  [
205  'pp_page',
206  'pp_propname',
207  'pp_value'
208  ],
209  [
210  'pp_page' => $queryIDs,
211  ],
212  __METHOD__
213  );
214 
215  $currentPageID = 0;
216  $pageProperties = [];
217  foreach ( $result as $row ) {
218  $pageID = $row->pp_page;
219  if ( $currentPageID != $pageID ) {
220  if ( $pageProperties != [] ) {
221  $this->cacheProperties( $currentPageID, $pageProperties );
222  $values[$currentPageID] = $pageProperties;
223  }
224  $currentPageID = $pageID;
225  $pageProperties = [];
226  }
227  $pageProperties[$row->pp_propname] = $row->pp_value;
228  }
229  if ( $pageProperties != [] ) {
230  $this->cacheProperties( $pageID, $pageProperties );
231  $values[$pageID] = $pageProperties;
232  }
233  }
234 
235  return $values;
236  }
237 
242  private function getGoodIDs( $titles ) {
243  $result = [];
244  if ( is_array( $titles ) ) {
245  ( new LinkBatch( $titles ) )->execute();
246 
247  foreach ( $titles as $title ) {
248  $pageID = $title->getArticleID();
249  if ( $pageID > 0 ) {
250  $result[] = $pageID;
251  }
252  }
253  } else {
254  $pageID = $titles->getArticleID();
255  if ( $pageID > 0 ) {
256  $result[] = $pageID;
257  }
258  }
259  return $result;
260  }
261 
269  private function getCachedProperty( $pageID, $propertyName ) {
270  if ( $this->cache->has( $pageID, $propertyName, self::CACHE_TTL ) ) {
271  return $this->cache->get( $pageID, $propertyName );
272  }
273  if ( $this->cache->has( 0, $pageID, self::CACHE_TTL ) ) {
274  $pageProperties = $this->cache->get( 0, $pageID );
275  if ( isset( $pageProperties[$propertyName] ) ) {
276  return $pageProperties[$propertyName];
277  }
278  }
279  return false;
280  }
281 
288  private function getCachedProperties( $pageID ) {
289  if ( $this->cache->has( 0, $pageID, self::CACHE_TTL ) ) {
290  return $this->cache->get( 0, $pageID );
291  }
292  return false;
293  }
294 
302  private function cacheProperty( $pageID, $propertyName, $propertyValue ) {
303  $this->cache->set( $pageID, $propertyName, $propertyValue );
304  }
305 
312  private function cacheProperties( $pageID, $pageProperties ) {
313  $this->cache->clear( $pageID );
314  $this->cache->set( 0, $pageID, $pageProperties );
315  }
316 }
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
$result
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
Definition: hooks.txt:1963
PageProps\getProperties
getProperties( $titles, $propertyNames)
Given one or more Titles and one or more names of properties, returns an associative array mapping pa...
Definition: PageProps.php:115
use
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
Definition: MIT-LICENSE.txt:10
PageProps\getCachedProperty
getCachedProperty( $pageID, $propertyName)
Get a property from the cache.
Definition: PageProps.php:269
cache
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:52
php
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
MWException
MediaWiki exception.
Definition: MWException.php:26
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
$titles
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2856
PageProps\getInstance
static getInstance()
Definition: PageProps.php:66
PageProps\overrideInstance
static overrideInstance(PageProps $store=null)
Overrides the default instance of this class This is intended for use while testing and will fail if ...
Definition: PageProps.php:50
PageProps\__construct
__construct()
Create a PageProps object.
Definition: PageProps.php:83
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
PageProps\getGoodIDs
getGoodIDs( $titles)
Definition: PageProps.php:242
PageProps\$instance
static PageProps $instance
Definition: PageProps.php:34
execute
$batch execute()
PageProps\CACHE_TTL
const CACHE_TTL
Cache parameters.
Definition: PageProps.php:74
PageProps\getAllProperties
getAllProperties( $titles)
Get all page property values.
Definition: PageProps.php:187
PageProps\CACHE_SIZE
const CACHE_SIZE
Definition: PageProps.php:75
$dbr
if(! $regexes) $dbr
Definition: cleanup.php:94
PageProps\cacheProperty
cacheProperty( $pageID, $propertyName, $propertyValue)
Save a property to the cache.
Definition: PageProps.php:302
PageProps\ensureCacheSize
ensureCacheSize( $size)
Ensure that cache has at least this size.
Definition: PageProps.php:91
PageProps
Gives access to properties of a page.
Definition: PageProps.php:29
PageProps\getCachedProperties
getCachedProperties( $pageID)
Get properties from the cache.
Definition: PageProps.php:288
as
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
PageProps\$cache
$cache
Property cache.
Definition: PageProps.php:78
ProcessCacheLRU
Handles per process caching of items.
Definition: ProcessCacheLRU.php:29
PageProps\cacheProperties
cacheProperties( $pageID, $pageProperties)
Save properties to the cache.
Definition: PageProps.php:312