Merge "Deprecate no longer used Skin::getCommonStylePath."
[lhc/web/wiklou.git] / includes / api / ApiQueryCategories.php
index 8ed4846..283eb13 100644 (file)
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( "ApiQueryBase.php" );
-}
-
 /**
  * A query module to enumerate categories the set of pages belong to.
  *
@@ -80,7 +75,7 @@ class ApiQueryCategories extends ApiQueryGeneratorBase {
                        foreach ( $params['categories'] as $cat ) {
                                $title = Title::newFromText( $cat );
                                if ( !$title || $title->getNamespace() != NS_CATEGORY ) {
-                                       $this->setWarning( "``$cat'' is not a category" );
+                                       $this->setWarning( "\"$cat\" is not a category" );
                                } else {
                                        $cats[] = $title->getDBkey();
                                }
@@ -94,12 +89,13 @@ class ApiQueryCategories extends ApiQueryGeneratorBase {
                                $this->dieUsage( "Invalid continue param. You should pass the " .
                                        "original value returned by the previous query", "_badcontinue" );
                        }
+                       $op = $params['dir'] == 'descending' ? '<' : '>';
                        $clfrom = intval( $cont[0] );
-                       $clto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
+                       $clto = $this->getDB()->addQuotes( $this->titleToKey( $cont[1] ) );
                        $this->addWhere(
-                               "cl_from > $clfrom OR " .
+                               "cl_from $op $clfrom OR " .
                                "(cl_from = $clfrom AND " .
-                               "cl_to >= '$clto')"
+                               "cl_to $op= $clto)"
                        );
                }
 
@@ -127,11 +123,16 @@ class ApiQueryCategories extends ApiQueryGeneratorBase {
                }
 
                $this->addOption( 'USE INDEX', array( 'categorylinks' => 'cl_from' ) );
+
+               $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
                // Don't order by cl_from if it's constant in the WHERE clause
                if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
-                       $this->addOption( 'ORDER BY', 'cl_to' );
+                       $this->addOption( 'ORDER BY', 'cl_to' . $sort );
                } else {
-                       $this->addOption( 'ORDER BY', "cl_from, cl_to" );
+                       $this->addOption( 'ORDER BY', array(
+                                               'cl_from' . $sort,
+                                               'cl_to' . $sort
+                       ));
                }
 
                $res = $this->select( __METHOD__ );
@@ -213,6 +214,13 @@ class ApiQueryCategories extends ApiQueryGeneratorBase {
                        'categories' => array(
                                ApiBase::PARAM_ISMULTI => true,
                        ),
+                       'dir' => array(
+                               ApiBase::PARAM_DFLT => 'ascending',
+                               ApiBase::PARAM_TYPE => array(
+                                       'ascending',
+                                       'descending'
+                               )
+                       ),
                );
        }
 
@@ -228,6 +236,26 @@ class ApiQueryCategories extends ApiQueryGeneratorBase {
                        'show' => 'Which kind of categories to show',
                        'continue' => 'When more results are available, use this to continue',
                        'categories' => 'Only list these categories. Useful for checking whether a certain page is in a certain category',
+                       'dir' => 'The direction in which to list',
+               );
+       }
+
+       public function getResultProperties() {
+               return array(
+                       '' => array(
+                               'ns' => 'namespace',
+                               'title' => 'string'
+                       ),
+                       'sortkey' => array(
+                               'sortkey' => 'string',
+                               'sortkeyprefix' => 'string'
+                       ),
+                       'timestamp' => array(
+                               'timestamp' => 'timestamp'
+                       ),
+                       'hidden' => array(
+                               'hidden' => 'boolean'
+                       )
                );
        }
 
@@ -243,15 +271,13 @@ class ApiQueryCategories extends ApiQueryGeneratorBase {
 
        public function getExamples() {
                return array(
-                       'Get a list of categories [[Albert Einstein]] belongs to:',
-                       '  api.php?action=query&prop=categories&titles=Albert%20Einstein',
-                       'Get information about all categories used in the [[Albert Einstein]]:',
-                       '  api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info'
+                       'api.php?action=query&prop=categories&titles=Albert%20Einstein' => 'Get a list of categories [[Albert Einstein]] belongs to',
+                       'api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info' => 'Get information about all categories used in the [[Albert Einstein]]',
                );
        }
 
        public function getHelpUrls() {
-               return 'http://www.mediawiki.org/wiki/API:Properties#categories_.2F_cl';
+               return 'https://www.mediawiki.org/wiki/API:Properties#categories_.2F_cl';
        }
 
        public function getVersion() {