<?php
+/**
+ * Representation for a category.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @author Simetrical
+ */
+
/**
* Category objects are immutable, strictly speaking. If you call methods that change the database,
* like to refresh link counts, the objects will be appropriately reinitialized.
* Member variables are lazy-initialized.
*
* TODO: Move some stuff from CategoryPage.php to here, and use that.
- *
- * @author Simetrical
*/
-
class Category {
/** Name of the category, normalized to DB-key form */
private $mName = null;
private $mID = null;
- /** Category page title */
+ /**
+ * Category page title
+ * @var Title
+ */
private $mTitle = null;
/** Counts of membership (cat_pages, cat_subcats, cat_files) */
private $mPages = null, $mSubcats = null, $mFiles = null;
/**
* Set up all member variables using a database query.
+ * @throws MWException
* @return bool True on success, false on failure.
*/
protected function initialize() {
# Already initialized
return true;
}
+
+ wfProfileIn( __METHOD__ );
+
$dbr = wfGetDB( DB_SLAVE );
$row = $dbr->selectRow(
'category',
__METHOD__
);
+ wfProfileOut( __METHOD__ );
+
if ( !$row ) {
# Okay, there were no contents. Nothing to initialize.
if ( $this->mTitle ) {
# If there is a title object but no record in the category table, treat this as an empty category
- $this->mID = false;
- $this->mName = $this->mTitle->getDBkey();
- $this->mPages = 0;
+ $this->mID = false;
+ $this->mName = $this->mTitle->getDBkey();
+ $this->mPages = 0;
$this->mSubcats = 0;
- $this->mFiles = 0;
+ $this->mFiles = 0;
return true;
} else {
}
}
- $this->mID = $row->cat_id;
- $this->mName = $row->cat_title;
- $this->mPages = $row->cat_pages;
+ $this->mID = $row->cat_id;
+ $this->mName = $row->cat_title;
+ $this->mPages = $row->cat_pages;
$this->mSubcats = $row->cat_subcats;
- $this->mFiles = $row->cat_files;
+ $this->mFiles = $row->cat_files;
# (bug 13683) If the count is negative, then 1) it's obviously wrong
# and should not be kept, and 2) we *probably* don't have to scan many
* Factory function.
*
* @param $title Title for the category page
- * @return Mixed: category, or false on a totally invalid name
+ * @return Category|bool on a totally invalid name
*/
public static function newFromTitle( $title ) {
$cat = new self();
* @param $row result set row, must contain the cat_xxx fields. If the fields are null,
* the resulting Category object will represent an empty category if a title object
* was given. If the fields are null and no title was given, this method fails and returns false.
- * @param $title optional title object for the category represented by the given row.
+ * @param Title $title optional title object for the category represented by the given row.
* May be provided if it is already known, to avoid having to re-create a title object later.
* @return Category
*/
$cat->mName = $title->getDBkey(); # if we have a title object, fetch the category name from there
}
- $cat->mID = false;
+ $cat->mID = false;
$cat->mSubcats = 0;
- $cat->mPages = 0;
- $cat->mFiles = 0;
+ $cat->mPages = 0;
+ $cat->mFiles = 0;
} else {
- $cat->mName = $row->cat_title;
- $cat->mID = $row->cat_id;
+ $cat->mName = $row->cat_title;
+ $cat->mID = $row->cat_id;
$cat->mSubcats = $row->cat_subcats;
- $cat->mPages = $row->cat_pages;
- $cat->mFiles = $row->cat_files;
+ $cat->mPages = $row->cat_pages;
+ $cat->mFiles = $row->cat_files;
}
return $cat;
}
/** @return mixed DB key name, or false on failure */
- public function getName() { return $this->getX( 'mName' ); }
+ public function getName() {
+ return $this->getX( 'mName' );
+ }
/** @return mixed Category ID, or false on failure */
- public function getID() { return $this->getX( 'mID' ); }
+ public function getID() {
+ return $this->getX( 'mID' );
+ }
/** @return mixed Total number of member pages, or false on failure */
- public function getPageCount() { return $this->getX( 'mPages' ); }
+ public function getPageCount() {
+ return $this->getX( 'mPages' );
+ }
/** @return mixed Number of subcategories, or false on failure */
- public function getSubcatCount() { return $this->getX( 'mSubcats' ); }
+ public function getSubcatCount() {
+ return $this->getX( 'mSubcats' );
+ }
/** @return mixed Number of member files, or false on failure */
- public function getFileCount() { return $this->getX( 'mFiles' ); }
+ public function getFileCount() {
+ return $this->getX( 'mFiles' );
+ }
/**
- * @return mixed The Title for this category, or false on failure.
+ * @return Title|bool Title for this category, or false on failure.
*/
public function getTitle() {
- if ( $this->mTitle ) return $this->mTitle;
+ if ( $this->mTitle ) {
+ return $this->mTitle;
+ }
if ( !$this->initialize() ) {
return false;
* @return TitleArray object for category members.
*/
public function getMembers( $limit = false, $offset = '' ) {
+ wfProfileIn( __METHOD__ );
+
$dbr = wfGetDB( DB_SLAVE );
$conds = array( 'cl_to' => $this->getName(), 'cl_from = page_id' );
$options = array( 'ORDER BY' => 'cl_sortkey' );
if ( $limit ) {
- $options[ 'LIMIT' ] = $limit;
+ $options['LIMIT'] = $limit;
}
if ( $offset !== '' ) {
$conds[] = 'cl_sortkey > ' . $dbr->addQuotes( $offset );
}
- return TitleArray::newFromResult(
+ $result = TitleArray::newFromResult(
$dbr->select(
array( 'page', 'categorylinks' ),
array( 'page_id', 'page_namespace', 'page_title', 'page_len',
$options
)
);
+
+ wfProfileOut( __METHOD__ );
+
+ return $result;
}
- /** Generic accessor */
+ /**
+ * Generic accessor
+ * @return bool
+ */
private function getX( $key ) {
if ( !$this->initialize() ) {
return false;
}
- return $this-> { $key } ;
+ return $this->{$key};
}
/**
}
}
+ wfProfileIn( __METHOD__ );
+
$dbw = wfGetDB( DB_MASTER );
- $dbw->begin();
+ $dbw->begin( __METHOD__ );
- # Let's be sure that the row exists in the table. We don't need to
- # do this if we got the row from the table in initialization!
+ # Insert the row if it doesn't exist yet (e.g., this is being run via
+ # update.php from a pre-1.16 schema). TODO: This will cause lots and
+ # lots of gaps on some non-MySQL DBMSes if you run populateCategory.php
+ # repeatedly. Plus it's an extra query that's unneeded almost all the
+ # time. This should be rewritten somehow, probably.
$seqVal = $dbw->nextSequenceValue( 'category_cat_id_seq' );
$dbw->insert(
'category',
'IGNORE'
);
- $cond1 = $dbw->conditional( 'page_namespace=' . NS_CATEGORY, 1, 'NULL' );
- $cond2 = $dbw->conditional( 'page_namespace=' . NS_FILE, 1, 'NULL' );
+ $cond1 = $dbw->conditional( array( 'page_namespace' => NS_CATEGORY ), 1, 'NULL' );
+ $cond2 = $dbw->conditional( array( 'page_namespace' => NS_FILE ), 1, 'NULL' );
$result = $dbw->selectRow(
array( 'categorylinks', 'page' ),
- array( 'COUNT(*) AS pages',
- "COUNT($cond1) AS subcats",
- "COUNT($cond2) AS files"
+ array( 'pages' => 'COUNT(*)',
+ 'subcats' => "COUNT($cond1)",
+ 'files' => "COUNT($cond2)"
),
array( 'cl_to' => $this->mName, 'page_id = cl_from' ),
__METHOD__,
- 'LOCK IN SHARE MODE'
+ array( 'LOCK IN SHARE MODE' )
);
$ret = $dbw->update(
'category',
array( 'cat_title' => $this->mName ),
__METHOD__
);
- $dbw->commit();
+ $dbw->commit( __METHOD__ );
+
+ wfProfileOut( __METHOD__ );
# Now we should update our local counts.
- $this->mPages = $result->pages;
+ $this->mPages = $result->pages;
$this->mSubcats = $result->subcats;
- $this->mFiles = $result->files;
+ $this->mFiles = $result->files;
return $ret;
}