]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/api/ApiQueryImages.php
MediaWiki 1.16.0-scripts
[autoinstallsdev/mediawiki.git] / includes / api / ApiQueryImages.php
index 69569e9bdfd77889a7f7380a7069640f5f56dc20..65df94dc4136eb57e3d4e49b42e60c10fb48d9e8 100644 (file)
@@ -23,9 +23,9 @@
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ("ApiQueryBase.php");
+       require_once ( "ApiQueryBase.php" );
 }
 
 /**
@@ -35,69 +35,70 @@ if (!defined('MEDIAWIKI')) {
  */
 class ApiQueryImages extends ApiQueryGeneratorBase {
 
-       public function __construct($query, $moduleName) {
-               parent :: __construct($query, $moduleName, 'im');
+       public function __construct( $query, $moduleName ) {
+               parent :: __construct( $query, $moduleName, 'im' );
        }
 
        public function execute() {
                $this->run();
        }
 
-       public function executeGenerator($resultPageSet) {
-               $this->run($resultPageSet);
+       public function executeGenerator( $resultPageSet ) {
+               $this->run( $resultPageSet );
        }
 
-       private function run($resultPageSet = null) {
+       private function run( $resultPageSet = null ) {
 
-               if ($this->getPageSet()->getGoodTitleCount() == 0)
+               if ( $this->getPageSet()->getGoodTitleCount() == 0 )
                        return; // nothing to do
 
                $params = $this->extractRequestParams();
-               $this->addFields(array (
+               $this->addFields( array (
                        'il_from',
                        'il_to'
-               ));
-
-               $this->addTables('imagelinks');
-               $this->addWhereFld('il_from', array_keys($this->getPageSet()->getGoodTitles()));
-               if(!is_null($params['continue'])) {
-                       $cont = explode('|', $params['continue']);
-                       if(count($cont) != 2)
-                               $this->dieUsage("Invalid continue param. You should pass the " .
-                                       "original value returned by the previous query", "_badcontinue");
-                       $ilfrom = intval($cont[0]);
-                       $ilto = $this->getDB()->strencode($this->titleToKey($cont[1]));
-                       $this->addWhere("il_from > $ilfrom OR ".
-                                       "(il_from = $ilfrom AND ".
-                                       "il_to >= '$ilto')");
+               ) );
+
+               $this->addTables( 'imagelinks' );
+               $this->addWhereFld( 'il_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
+               if ( !is_null( $params['continue'] ) ) {
+                       $cont = explode( '|', $params['continue'] );
+                       if ( count( $cont ) != 2 )
+                               $this->dieUsage( "Invalid continue param. You should pass the " .
+                                       "original value returned by the previous query", "_badcontinue" );
+                       $ilfrom = intval( $cont[0] );
+                       $ilto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
+                       $this->addWhere( "il_from > $ilfrom OR " .
+                                       "(il_from = $ilfrom AND " .
+                                       "il_to >= '$ilto')" );
                }
-               # Don't order by il_from if it's constant in the WHERE clause
-               if(count($this->getPageSet()->getGoodTitles()) == 1)
-                       $this->addOption('ORDER BY', 'il_to');
+
+               // Don't order by il_from if it's constant in the WHERE clause
+               if ( count( $this->getPageSet()->getGoodTitles() ) == 1 )
+                       $this->addOption( 'ORDER BY', 'il_to' );
                else
-                       $this->addOption('ORDER BY', 'il_from, il_to');
-               $this->addOption('LIMIT', $params['limit'] + 1);
+                       $this->addOption( 'ORDER BY', 'il_from, il_to' );
+               $this->addOption( 'LIMIT', $params['limit'] + 1 );
 
                $db = $this->getDB();
-               $res = $this->select(__METHOD__);
+               $res = $this->select( __METHOD__ );
 
-               if (is_null($resultPageSet)) {
+               if ( is_null( $resultPageSet ) ) {
                        $count = 0;
-                       while ($row = $db->fetchObject($res)) {
-                               if (++$count > $params['limit']) {
+                       while ( $row = $db->fetchObject( $res ) ) {
+                               if ( ++$count > $params['limit'] ) {
                                        // We've reached the one extra which shows that
                                        // there are additional pages to be had. Stop here...
-                                       $this->setContinueEnumParameter('continue', $row->il_from .
-                                                       '|' . $this->keyToTitle($row->il_to));
+                                       $this->setContinueEnumParameter( 'continue', $row->il_from .
+                                                       '|' . $this->keyToTitle( $row->il_to ) );
                                        break;
                                }
                                $vals = array();
-                               ApiQueryBase :: addTitleInfo($vals, Title :: makeTitle(NS_FILE, $row->il_to));
-                               $fit = $this->addPageSubItem($row->il_from, $vals);
-                               if(!$fit)
+                               ApiQueryBase :: addTitleInfo( $vals, Title :: makeTitle( NS_FILE, $row->il_to ) );
+                               $fit = $this->addPageSubItem( $row->il_from, $vals );
+                               if ( !$fit )
                                {
-                                       $this->setContinueEnumParameter('continue', $row->il_from .
-                                                       '|' . $this->keyToTitle($row->il_to));
+                                       $this->setContinueEnumParameter( 'continue', $row->il_from .
+                                                       '|' . $this->keyToTitle( $row->il_to ) );
                                        break;
                                }
                        }
@@ -105,20 +106,24 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
 
                        $titles = array();
                        $count = 0;
-                       while ($row = $db->fetchObject($res)) {
-                               if (++$count > $params['limit']) {
+                       while ( $row = $db->fetchObject( $res ) ) {
+                               if ( ++$count > $params['limit'] ) {
                                        // We've reached the one extra which shows that
                                        // there are additional pages to be had. Stop here...
-                                       $this->setContinueEnumParameter('continue', $row->il_from .
-                                                       '|' . $this->keyToTitle($row->il_to));
+                                       $this->setContinueEnumParameter( 'continue', $row->il_from .
+                                                       '|' . $this->keyToTitle( $row->il_to ) );
                                        break;
                                }
-                               $titles[] = Title :: makeTitle(NS_FILE, $row->il_to);
+                               $titles[] = Title :: makeTitle( NS_FILE, $row->il_to );
                        }
-                       $resultPageSet->populateFromTitles($titles);
+                       $resultPageSet->populateFromTitles( $titles );
                }
 
-               $db->freeResult($res);
+               $db->freeResult( $res );
+       }
+
+       public function getCacheMode( $params ) {
+               return 'public';
        }
 
        public function getAllowedParams() {
@@ -144,6 +149,12 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
        public function getDescription() {
                return 'Returns all images contained on the given page(s)';
        }
+       
+       public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(), array(
+                       array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
+               ) );
+       }
 
        protected function getExamples() {
                return array (
@@ -155,6 +166,6 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
        }
 
        public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryImages.php 46845 2009-02-05 14:30:59Z catrope $';
+               return __CLASS__ . ': $Id: ApiQueryImages.php 69932 2010-07-26 08:03:21Z tstarling $';
        }
-}
\ No newline at end of file
+}