API: fix copyright symbol, coding style cleanup, more braces
[lhc/web/wiklou.git] / includes / api / ApiQueryImages.php
index ba6fdcb..b6dfc1a 100644 (file)
@@ -1,11 +1,11 @@
 <?php
 
-/*
+/**
  * Created on May 13, 2007
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * 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
@@ -25,7 +25,7 @@
 
 if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ( "ApiQueryBase.php" );
+       require_once( "ApiQueryBase.php" );
 }
 
 /**
@@ -36,7 +36,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiQueryImages extends ApiQueryGeneratorBase {
 
        public function __construct( $query, $moduleName ) {
-               parent :: __construct( $query, $moduleName, 'im' );
+               parent::__construct( $query, $moduleName, 'im' );
        }
 
        public function execute() {
@@ -48,12 +48,12 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
        }
 
        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'
                ) );
@@ -62,21 +62,25 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                $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" );
+                       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->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 )
+               if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
                        $this->addOption( 'ORDER BY', 'il_to' );
-               else
+               } else {
                        $this->addOption( 'ORDER BY', 'il_from, il_to' );
+               }
                $this->addOption( 'LIMIT', $params['limit'] + 1 );
 
                $db = $this->getDB();
@@ -93,17 +97,15 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                                        break;
                                }
                                $vals = array();
-                               ApiQueryBase :: addTitleInfo( $vals, Title :: makeTitle( NS_FILE, $row->il_to ) );
+                               ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( NS_FILE, $row->il_to ) );
                                $fit = $this->addPageSubItem( $row->il_from, $vals );
-                               if ( !$fit )
-                               {
+                               if ( !$fit ) {
                                        $this->setContinueEnumParameter( 'continue', $row->il_from .
                                                        '|' . $this->keyToTitle( $row->il_to ) );
                                        break;
                                }
                        }
                } else {
-
                        $titles = array();
                        $count = 0;
                        while ( $row = $db->fetchObject( $res ) ) {
@@ -114,7 +116,7 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
                                                        '|' . $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 );
                }
@@ -124,18 +126,18 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
 
        public function getAllowedParams() {
                return array(
-                               '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
-                               ),
-                               'continue' => null,
+                       '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
+                       ),
+                       'continue' => null,
                );
        }
 
-       public function getParamDescription () {
+       public function getParamDescription() {
                return array(
                        'limit' => 'How many images to return',
                        'continue' => 'When more results are available, use this to continue',
@@ -145,7 +147,7 @@ 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' ),
@@ -153,12 +155,12 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
        }
 
        protected 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"
-                       );
+               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'
+               );
        }
 
        public function getVersion() {