MediaWiki  1.23.2
Category.php
Go to the documentation of this file.
1 <?php
31 class Category {
33  private $mName = null;
34  private $mID = null;
39  private $mTitle = null;
41  private $mPages = null, $mSubcats = null, $mFiles = null;
42 
43  private function __construct() {
44  }
45 
51  protected function initialize() {
52  if ( $this->mName === null && $this->mID === null ) {
53  throw new MWException( __METHOD__ . ' has both names and IDs null' );
54  } elseif ( $this->mID === null ) {
55  $where = array( 'cat_title' => $this->mName );
56  } elseif ( $this->mName === null ) {
57  $where = array( 'cat_id' => $this->mID );
58  } else {
59  # Already initialized
60  return true;
61  }
62 
63  wfProfileIn( __METHOD__ );
64 
65  $dbr = wfGetDB( DB_SLAVE );
66  $row = $dbr->selectRow(
67  'category',
68  array( 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ),
69  $where,
70  __METHOD__
71  );
72 
73  wfProfileOut( __METHOD__ );
74 
75  if ( !$row ) {
76  # Okay, there were no contents. Nothing to initialize.
77  if ( $this->mTitle ) {
78  # If there is a title object but no record in the category table,
79  # treat this as an empty category.
80  $this->mID = false;
81  $this->mName = $this->mTitle->getDBkey();
82  $this->mPages = 0;
83  $this->mSubcats = 0;
84  $this->mFiles = 0;
85 
86  return true;
87  } else {
88  return false; # Fail
89  }
90  }
91 
92  $this->mID = $row->cat_id;
93  $this->mName = $row->cat_title;
94  $this->mPages = $row->cat_pages;
95  $this->mSubcats = $row->cat_subcats;
96  $this->mFiles = $row->cat_files;
97 
98  # (bug 13683) If the count is negative, then 1) it's obviously wrong
99  # and should not be kept, and 2) we *probably* don't have to scan many
100  # rows to obtain the correct figure, so let's risk a one-time recount.
101  if ( $this->mPages < 0 || $this->mSubcats < 0 || $this->mFiles < 0 ) {
102  $this->refreshCounts();
103  }
104 
105  return true;
106  }
107 
115  public static function newFromName( $name ) {
116  $cat = new self();
118 
119  if ( !is_object( $title ) ) {
120  return false;
121  }
122 
123  $cat->mTitle = $title;
124  $cat->mName = $title->getDBkey();
125 
126  return $cat;
127  }
128 
135  public static function newFromTitle( $title ) {
136  $cat = new self();
137 
138  $cat->mTitle = $title;
139  $cat->mName = $title->getDBkey();
140 
141  return $cat;
142  }
143 
150  public static function newFromID( $id ) {
151  $cat = new self();
152  $cat->mID = intval( $id );
153  return $cat;
154  }
155 
168  public static function newFromRow( $row, $title = null ) {
169  $cat = new self();
170  $cat->mTitle = $title;
171 
172  # NOTE: the row often results from a LEFT JOIN on categorylinks. This may result in
173  # all the cat_xxx fields being null, if the category page exists, but nothing
174  # was ever added to the category. This case should be treated link an empty
175  # category, if possible.
176 
177  if ( $row->cat_title === null ) {
178  if ( $title === null ) {
179  # the name is probably somewhere in the row, for example as page_title,
180  # but we can't know that here...
181  return false;
182  } else {
183  # if we have a title object, fetch the category name from there
184  $cat->mName = $title->getDBkey();
185  }
186 
187  $cat->mID = false;
188  $cat->mSubcats = 0;
189  $cat->mPages = 0;
190  $cat->mFiles = 0;
191  } else {
192  $cat->mName = $row->cat_title;
193  $cat->mID = $row->cat_id;
194  $cat->mSubcats = $row->cat_subcats;
195  $cat->mPages = $row->cat_pages;
196  $cat->mFiles = $row->cat_files;
197  }
198 
199  return $cat;
200  }
201 
205  public function getName() {
206  return $this->getX( 'mName' );
207  }
208 
212  public function getID() {
213  return $this->getX( 'mID' );
214  }
215 
219  public function getPageCount() {
220  return $this->getX( 'mPages' );
221  }
222 
226  public function getSubcatCount() {
227  return $this->getX( 'mSubcats' );
228  }
229 
233  public function getFileCount() {
234  return $this->getX( 'mFiles' );
235  }
236 
240  public function getTitle() {
241  if ( $this->mTitle ) {
242  return $this->mTitle;
243  }
244 
245  if ( !$this->initialize() ) {
246  return false;
247  }
248 
249  $this->mTitle = Title::makeTitleSafe( NS_CATEGORY, $this->mName );
250  return $this->mTitle;
251  }
252 
260  public function getMembers( $limit = false, $offset = '' ) {
261  wfProfileIn( __METHOD__ );
262 
263  $dbr = wfGetDB( DB_SLAVE );
264 
265  $conds = array( 'cl_to' => $this->getName(), 'cl_from = page_id' );
266  $options = array( 'ORDER BY' => 'cl_sortkey' );
267 
268  if ( $limit ) {
269  $options['LIMIT'] = $limit;
270  }
271 
272  if ( $offset !== '' ) {
273  $conds[] = 'cl_sortkey > ' . $dbr->addQuotes( $offset );
274  }
275 
277  $dbr->select(
278  array( 'page', 'categorylinks' ),
279  array( 'page_id', 'page_namespace', 'page_title', 'page_len',
280  'page_is_redirect', 'page_latest' ),
281  $conds,
282  __METHOD__,
283  $options
284  )
285  );
286 
287  wfProfileOut( __METHOD__ );
288 
289  return $result;
290  }
291 
296  private function getX( $key ) {
297  if ( !$this->initialize() ) {
298  return false;
299  }
300  return $this->{$key};
301  }
302 
308  public function refreshCounts() {
309  if ( wfReadOnly() ) {
310  return false;
311  }
312 
313  # Note, we must use names for this, since categorylinks does.
314  if ( $this->mName === null ) {
315  if ( !$this->initialize() ) {
316  return false;
317  }
318  }
319 
320  wfProfileIn( __METHOD__ );
321 
322  $dbw = wfGetDB( DB_MASTER );
323  $dbw->begin( __METHOD__ );
324 
325  # Insert the row if it doesn't exist yet (e.g., this is being run via
326  # update.php from a pre-1.16 schema). TODO: This will cause lots and
327  # lots of gaps on some non-MySQL DBMSes if you run populateCategory.php
328  # repeatedly. Plus it's an extra query that's unneeded almost all the
329  # time. This should be rewritten somehow, probably.
330  $seqVal = $dbw->nextSequenceValue( 'category_cat_id_seq' );
331  $dbw->insert(
332  'category',
333  array(
334  'cat_id' => $seqVal,
335  'cat_title' => $this->mName
336  ),
337  __METHOD__,
338  'IGNORE'
339  );
340 
341  $cond1 = $dbw->conditional( array( 'page_namespace' => NS_CATEGORY ), 1, 'NULL' );
342  $cond2 = $dbw->conditional( array( 'page_namespace' => NS_FILE ), 1, 'NULL' );
343  $result = $dbw->selectRow(
344  array( 'categorylinks', 'page' ),
345  array( 'pages' => 'COUNT(*)',
346  'subcats' => "COUNT($cond1)",
347  'files' => "COUNT($cond2)"
348  ),
349  array( 'cl_to' => $this->mName, 'page_id = cl_from' ),
350  __METHOD__,
351  array( 'LOCK IN SHARE MODE' )
352  );
353  $ret = $dbw->update(
354  'category',
355  array(
356  'cat_pages' => $result->pages,
357  'cat_subcats' => $result->subcats,
358  'cat_files' => $result->files
359  ),
360  array( 'cat_title' => $this->mName ),
361  __METHOD__
362  );
363  $dbw->commit( __METHOD__ );
364 
365  wfProfileOut( __METHOD__ );
366 
367  # Now we should update our local counts.
368  $this->mPages = $result->pages;
369  $this->mSubcats = $result->subcats;
370  $this->mFiles = $result->files;
371 
372  return $ret;
373  }
374 }
Category\getTitle
getTitle()
Definition: Category.php:239
$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. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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 '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) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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:1528
DB_MASTER
const DB_MASTER
Definition: Defines.php:56
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
Category\getID
getID()
Definition: Category.php:211
TitleArray\newFromResult
static newFromResult( $res)
Definition: TitleArray.php:38
Category\$mName
$mName
Name of the category, normalized to DB-key form.
Definition: Category.php:33
wfGetDB
& wfGetDB( $db, $groups=array(), $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3650
Category
Category objects are immutable, strictly speaking.
Definition: Category.php:31
wfProfileIn
wfProfileIn( $functionname)
Begin profiling of a function.
Definition: Profiler.php:33
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1530
NS_FILE
const NS_FILE
Definition: Defines.php:85
$limit
if( $sleep) $limit
Definition: importImages.php:99
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1313
$dbr
$dbr
Definition: testCompression.php:48
Category\initialize
initialize()
Set up all member variables using a database query.
Definition: Category.php:50
MWException
MediaWiki exception.
Definition: MWException.php:26
Category\getX
getX( $key)
Generic accessor.
Definition: Category.php:295
Category\$mFiles
$mFiles
Definition: Category.php:40
Category\$mID
$mID
Definition: Category.php:34
Category\refreshCounts
refreshCounts()
Refresh the counts for this category.
Definition: Category.php:307
Category\getName
getName()
Definition: Category.php:204
wfProfileOut
wfProfileOut( $functionname='missing')
Stop profiling of a function.
Definition: Profiler.php:46
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
Category\getSubcatCount
getSubcatCount()
Definition: Category.php:225
Category\getMembers
getMembers( $limit=false, $offset='')
Fetch a TitleArray of up to $limit category members, beginning after the category sort key $offset.
Definition: Category.php:259
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:93
Category\$mSubcats
$mSubcats
Definition: Category.php:40
Category\newFromRow
static newFromRow( $row, $title=null)
Factory function, for constructing a Category object from a result set.
Definition: Category.php:167
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1530
Category\newFromTitle
static newFromTitle( $title)
Factory function.
Definition: Category.php:134
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:422
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
Category\getPageCount
getPageCount()
Definition: Category.php:218
Category\newFromID
static newFromID( $id)
Factory function.
Definition: Category.php:149
DB_SLAVE
const DB_SLAVE
Definition: Defines.php:55
Title
Represents a title within MediaWiki.
Definition: Title.php:35
Category\getFileCount
getFileCount()
Definition: Category.php:232
Category\$mTitle
Title $mTitle
Category page title.
Definition: Category.php:38
Category\__construct
__construct()
Definition: Category.php:42
Category\newFromName
static newFromName( $name)
Factory function.
Definition: Category.php:114
Category\$mPages
$mPages
Counts of membership (cat_pages, cat_subcats, cat_files)
Definition: Category.php:40