includes/specialpage/ImageQueryPage.php

   1 <?php
   2 /**
   3  * Variant of QueryPage which uses a gallery to output results.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 use Wikimedia\Rdbms\ResultWrapper;
  25
  26 /**
  27  * Variant of QueryPage which uses a gallery to output results, thus
  28  * suited for reports generating images
  29  *
  30  * @ingroup SpecialPage
  31  * @author Rob Church <robchur@gmail.com>
  32  */
  33 abstract class ImageQueryPage extends QueryPage {
  34         /**
  35          * Format and output report results using the given information plus
  36          * OutputPage
  37          *
  38          * @param OutputPage $out OutputPage to print to
  39          * @param Skin $skin User skin to use [unused]
  40          * @param IDatabase $dbr (read) connection to use
  41          * @param ResultWrapper $res Result pointer
  42          * @param int $num Number of available result rows
  43          * @param int $offset Paging offset
  44          */
  45         protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
  46                 if ( $num > 0 ) {
  47                         $gallery = ImageGalleryBase::factory( false, $this->getContext() );
  48
  49                         # $res might contain the whole 1,000 rows, so we read up to
  50                         # $num [should update this to use a Pager]
  51                         $i = 0;
  52                         foreach ( $res as $row ) {
  53                                 $i++;
  54                                 $namespace = isset( $row->namespace ) ? $row->namespace : NS_FILE;
  55                                 $title = Title::makeTitleSafe( $namespace, $row->title );
  56                                 if ( $title instanceof Title && $title->getNamespace() == NS_FILE ) {
  57                                         $gallery->add( $title, $this->getCellHtml( $row ) );
  58                                 }
  59                                 if ( $i === $num ) {
  60                                         break;
  61                                 }
  62                         }
  63
  64                         $out->addHTML( $gallery->toHTML() );
  65                 }
  66         }
  67
  68         // Gotta override this since it's abstract
  69         function formatResult( $skin, $result ) {
  70         }
  71
  72         /**
  73          * Get additional HTML to be shown in a results' cell
  74          *
  75          * @param object $row Result row
  76          * @return string
  77          */
  78         protected function getCellHtml( $row ) {
  79                 return '';
  80         }
  81 }