includes/media/Bitmap_ClientOnly.php

   1 <?php
   2 /**
   3  * Handler for bitmap images that will be resized by clients.
   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 Media
  22  */
  23
  24 /**
  25  * Handler for bitmap images that will be resized by clients.
  26  *
  27  * This is not used by default but can be assigned to some image types
  28  * using $wgMediaHandlers.
  29  *
  30  * @ingroup Media
  31  */
  32 // phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
  33 class BitmapHandler_ClientOnly extends BitmapHandler {
  34
  35         /**
  36          * @param File $image
  37          * @param array &$params
  38          * @return bool
  39          */
  40         function normaliseParams( $image, &$params ) {
  41                 return ImageHandler::normaliseParams( $image, $params );
  42         }
  43
  44         /**
  45          * @param File $image
  46          * @param string $dstPath
  47          * @param string $dstUrl
  48          * @param array $params
  49          * @param int $flags
  50          * @return ThumbnailImage|TransformParameterError
  51          */
  52         function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
  53                 if ( !$this->normaliseParams( $image, $params ) ) {
  54                         return new TransformParameterError( $params );
  55                 }
  56
  57                 return new ThumbnailImage( $image, $image->getUrl(), $image->getLocalRefPath(), $params );
  58         }
  59 }