summaryrefslogtreecommitdiff
path: root/includes/api/ApiQueryAllCategories.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/api/ApiQueryAllCategories.php')
-rw-r--r--includes/api/ApiQueryAllCategories.php91
1 files changed, 49 insertions, 42 deletions
diff --git a/includes/api/ApiQueryAllCategories.php b/includes/api/ApiQueryAllCategories.php
index 8f24fc7c..c1473252 100644
--- a/includes/api/ApiQueryAllCategories.php
+++ b/includes/api/ApiQueryAllCategories.php
@@ -1,11 +1,10 @@
<?php
-
-/*
- * Created on December 12, 2007
- *
+/**
* API for MediaWiki 1.8+
*
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Created on December 12, 2007
+ *
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
*
* 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
@@ -19,13 +18,15 @@
*
* 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ( 'ApiQueryBase.php' );
+ require_once( 'ApiQueryBase.php' );
}
/**
@@ -37,7 +38,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
class ApiQueryAllCategories extends ApiQueryGeneratorBase {
public function __construct( $query, $moduleName ) {
- parent :: __construct( $query, $moduleName, 'ac' );
+ parent::__construct( $query, $moduleName, 'ac' );
}
public function execute() {
@@ -53,7 +54,6 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
}
private function run( $resultPageSet = null ) {
-
$db = $this->getDB();
$params = $this->extractRequestParams();
@@ -62,17 +62,19 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
$dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
$from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) );
- $this->addWhereRange( 'cat_title', $dir, $from, null );
- if ( isset ( $params['prefix'] ) )
+ $to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) );
+ $this->addWhereRange( 'cat_title', $dir, $from, $to );
+
+ if ( isset( $params['prefix'] ) ) {
$this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
+ }
$this->addOption( 'LIMIT', $params['limit'] + 1 );
$this->addOption( 'ORDER BY', 'cat_title' . ( $params['dir'] == 'descending' ? ' DESC' : '' ) );
$prop = array_flip( $params['prop'] );
$this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
- if ( isset( $prop['hidden'] ) )
- {
+ if ( isset( $prop['hidden'] ) ) {
$this->addTables( array( 'page', 'page_props' ) );
$this->addJoinConds( array(
'page' => array( 'LEFT JOIN', array(
@@ -88,10 +90,10 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
$res = $this->select( __METHOD__ );
$pages = array();
- $categories = array();
+
$result = $this->getResult();
$count = 0;
- while ( $row = $db->fetchObject( $res ) ) {
+ foreach ( $res as $row ) {
if ( ++ $count > $params['limit'] ) {
// We've reached the one extra which shows that there are additional cats to be had. Stop here...
// TODO: Security issue - if the user has no right to view next title, it will still be shown
@@ -101,9 +103,9 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
// Normalize titles
$titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
- if ( !is_null( $resultPageSet ) )
+ if ( !is_null( $resultPageSet ) ) {
$pages[] = $titleObj->getPrefixedText();
- else {
+ } else {
$item = array();
$result->setContent( $item, $titleObj->getText() );
if ( isset( $prop['size'] ) ) {
@@ -112,17 +114,16 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
$item['files'] = intval( $row->cat_files );
$item['subcats'] = intval( $row->cat_subcats );
}
- if ( isset( $prop['hidden'] ) && $row->cat_hidden )
+ if ( isset( $prop['hidden'] ) && $row->cat_hidden ) {
$item['hidden'] = '';
+ }
$fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
- if ( !$fit )
- {
+ if ( !$fit ) {
$this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) );
break;
}
}
}
- $db->freeResult( $res );
if ( is_null( $resultPageSet ) ) {
$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
@@ -132,38 +133,44 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
}
public function getAllowedParams() {
- return array (
+ return array(
'from' => null,
+ 'to' => null,
'prefix' => null,
'dir' => array(
- ApiBase :: PARAM_DFLT => 'ascending',
- ApiBase :: PARAM_TYPE => array(
+ ApiBase::PARAM_DFLT => 'ascending',
+ ApiBase::PARAM_TYPE => array(
'ascending',
'descending'
),
),
- 'limit' => array (
- ApiBase :: PARAM_DFLT => 10,
- ApiBase :: PARAM_TYPE => 'limit',
- ApiBase :: PARAM_MIN => 1,
- ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
- ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
+ 'limit' => array(
+ ApiBase::PARAM_DFLT => 10,
+ ApiBase::PARAM_TYPE => 'limit',
+ ApiBase::PARAM_MIN => 1,
+ ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+ ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
),
- 'prop' => array (
- ApiBase :: PARAM_TYPE => array( 'size', 'hidden' ),
- ApiBase :: PARAM_DFLT => '',
- ApiBase :: PARAM_ISMULTI => true
+ 'prop' => array(
+ ApiBase::PARAM_TYPE => array( 'size', 'hidden' ),
+ ApiBase::PARAM_DFLT => '',
+ ApiBase::PARAM_ISMULTI => true
),
);
}
public function getParamDescription() {
- return array (
- 'from' => 'The category to start enumerating from.',
- 'prefix' => 'Search for all category titles that begin with this value.',
- 'dir' => 'Direction to sort in.',
- 'limit' => 'How many categories to return.',
- 'prop' => 'Which properties to get',
+ return array(
+ 'from' => 'The category to start enumerating from',
+ 'to' => 'The category to stop enumerating at',
+ 'prefix' => 'Search for all category titles that begin with this value',
+ 'dir' => 'Direction to sort in',
+ 'limit' => 'How many categories to return',
+ 'prop' => array(
+ 'Which properties to get',
+ ' size - Adds number of pages in the category',
+ ' hidden - Tags categories that are hidden with __HIDDENCAT__',
+ ),
);
}
@@ -172,13 +179,13 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
}
protected function getExamples() {
- return array (
+ return array(
'api.php?action=query&list=allcategories&acprop=size',
'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
);
}
public function getVersion() {
- return __CLASS__ . ': $Id: ApiQueryAllCategories.php 69932 2010-07-26 08:03:21Z tstarling $';
+ return __CLASS__ . ': $Id: ApiQueryAllCategories.php 70647 2010-08-07 19:59:42Z ialex $';
}
}
generated by cgit v1.2.2 (git 2.25.0) at 2024-04-18 07:25:00 +0000