HTML 2???

[lhc/web/wiklou.git] / includes / api / ApiQueryImages.php

diff --git a/includes/api/ApiQueryImages.php b/includes/api/ApiQueryImages.php
index 1d85a77..f03b287 100644 (file)
--- a/includes/api/ApiQueryImages.php
+++ b/includes/api/ApiQueryImages.php
@@ -1,9 +1,8 @@
 <?php
-
 /**
- * Created on May 13, 2007
  *
- * API for MediaWiki 1.8+
+ *
+ * Created on May 13, 2007
  *
  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
@@ -19,15 +18,12 @@
  *
  * 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" );
-}
-
 /**
  * This query adds an <images> subelement to all pages with the list of images embedded into those pages.
  *
@@ -47,6 +43,9 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                $this->run( $resultPageSet );
        }
 
+       /**
+        * @param $resultPageSet ApiPageSet
+        */
        private function run( $resultPageSet = null ) {
                if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
                        return; // nothing to do
@@ -75,15 +74,31 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                        );
                }
 
+               $dir = ( $params['dir'] == 'descending' ? ' DESC' : '' );
                // 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' );
+                       $this->addOption( 'ORDER BY', 'il_to' . $dir );
                } else {
-                       $this->addOption( 'ORDER BY', 'il_from, il_to' );
+                       $this->addOption( 'ORDER BY', array(
+                                               'il_from' . $dir,
+                                               'il_to' . $dir
+                       ));
                }
                $this->addOption( 'LIMIT', $params['limit'] + 1 );
 
-               $db = $this->getDB();
+               if ( !is_null( $params['images'] ) ) {
+                       $images = array();
+                       foreach ( $params['images'] as $img ) {
+                               $title = Title::newFromText( $img );
+                               if ( !$title || $title->getNamespace() != NS_FILE ) {
+                                       $this->setWarning( "\"$img\" is not a file" );
+                               } else {
+                                       $images[] = $title->getDBkey();
+                               }
+                       }
+                       $this->addWhereFld( 'il_to', $images );
+               }
+
                $res = $this->select( __METHOD__ );
 
                if ( is_null( $resultPageSet ) ) {
@@ -108,7 +123,7 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                } else {
                        $titles = array();
                        $count = 0;
-                       foreach ( $result as $row ) {
+                       foreach ( $res as $row ) {
                                if ( ++$count > $params['limit'] ) {
                                        // We've reached the one extra which shows that
                                        // there are additional pages to be had. Stop here...
@@ -122,6 +137,10 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                }
        }
 
+       public function getCacheMode( $params ) {
+               return 'public';
+       }
+
        public function getAllowedParams() {
                return array(
                        'limit' => array(
@@ -132,6 +151,16 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                                ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
                        ),
                        'continue' => null,
+                       'images' => array(
+                               ApiBase::PARAM_ISMULTI => true,
+                       ),
+                       'dir' => array(
+                               ApiBase::PARAM_DFLT => 'ascending',
+                               ApiBase::PARAM_TYPE => array(
+                                       'ascending',
+                                       'descending'
+                               )
+                       ),
                );
        }
 
@@ -139,6 +168,8 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                return array(
                        'limit' => 'How many images to return',
                        'continue' => 'When more results are available, use this to continue',
+                       'images' => 'Only list these images. Useful for checking whether a certain page has a certain Image.',
+                       'dir' => 'The direction in which to list',
                );
        }
 
@@ -152,16 +183,18 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                ) );
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
-                       'Get a list of images used in the [[Main Page]]:',
-                       '  api.php?action=query&prop=images&titles=Main%20Page',
-                       'Get information about all images used in the [[Main Page]]:',
-                       '  api.php?action=query&generator=images&titles=Main%20Page&prop=info'
+                       'api.php?action=query&prop=images&titles=Main%20Page' => 'Get a list of images used in the [[Main Page]]',
+                       'api.php?action=query&generator=images&titles=Main%20Page&prop=info' => 'Get information about all images used in the [[Main Page]]',
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Properties#images_.2F_im';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
-}
\ No newline at end of file
+}