* Standardised file description headers

[lhc/web/wiklou.git] / includes / media / Generic.php

diff --git a/includes/media/Generic.php b/includes/media/Generic.php
index b1c6394..9dbd7e3 100644 (file)
--- a/includes/media/Generic.php
+++ b/includes/media/Generic.php
@@ -1,6 +1,7 @@
 <?php
 /**
  * Media-handling base classes and generic functionality
+ *
  * @file
  * @ingroup Media
  */
@@ -71,18 +72,18 @@ abstract class MediaHandler {
         * Get an image size array like that returned by getimagesize(), or false if it
         * can't be determined.
         *
-        * @param Image $image The image object, or false if there isn't one
-        * @param string $fileName The filename
-        * @return array
+        * @param $image File: the image object, or false if there isn't one
+        * @param $path String: the filename
+        * @return Array
         */
        abstract function getImageSize( $image, $path );
 
        /**
         * Get handler-specific metadata which will be saved in the img_metadata field.
         *
-        * @param Image $image The image object, or false if there isn't one
-        * @param string $fileName The filename
-        * @return string
+        * @param $image File: the image object, or false if there isn't one
+        * @param $path String: the filename
+        * @return String
         */
        function getMetadata( $image, $path ) { return ''; }
 
@@ -114,10 +115,10 @@ abstract class MediaHandler {
         * Get a MediaTransformOutput object representing the transformed output. Does not
         * actually do the transform.
         *
-        * @param Image $image The image object
-        * @param string $dstPath Filesystem destination path
-        * @param string $dstUrl Destination URL to use in output HTML
-        * @param array $params Arbitrary set of parameters validated by $this->validateParam()
+        * @param $image File: the image object
+        * @param $dstPath String: filesystem destination path
+        * @param $dstUrl String: Destination URL to use in output HTML
+        * @param $params Array: Arbitrary set of parameters validated by $this->validateParam()
         */
        function getTransform( $image, $dstPath, $dstUrl, $params ) {
                return $this->doTransform( $image, $dstPath, $dstUrl, $params, self::TRANSFORM_LATER );
@@ -127,11 +128,11 @@ abstract class MediaHandler {
         * Get a MediaTransformOutput object representing the transformed output. Does the
         * transform unless $flags contains self::TRANSFORM_LATER.
         *
-        * @param Image $image The image object
-        * @param string $dstPath Filesystem destination path
-        * @param string $dstUrl Destination URL to use in output HTML
-        * @param array $params Arbitrary set of parameters validated by $this->validateParam()
-        * @param integer $flags A bitfield, may contain self::TRANSFORM_LATER
+        * @param $image File: the image object
+        * @param $dstPath String: filesystem destination path
+        * @param $dstUrl String: destination URL to use in output HTML
+        * @param $params Array: arbitrary set of parameters validated by $this->validateParam()
+        * @param $flags Integer: a bitfield, may contain self::TRANSFORM_LATER
         */
        abstract function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 );
 
@@ -139,7 +140,7 @@ abstract class MediaHandler {
         * Get the thumbnail extension and MIME type for a given source MIME type
         * @return array thumbnail extension and MIME type
         */
-       function getThumbType( $ext, $mime ) {
+       function getThumbType( $ext, $mime, $params = null ) {
                return array( $ext, $mime );
        }
 
@@ -218,7 +219,7 @@ abstract class MediaHandler {
        }
 
        /**
-        * @fixme document this!
+        * @todo Fixme: document this!
         * 'value' thingy goes into a wikitext table; it used to be escaped but
         * that was incompatible with previous practice of customized display
         * with wikitext formatting via messages such as 'exif-model-value'.
@@ -357,9 +358,19 @@ abstract class ImageHandler extends MediaHandler {
                if ( !isset( $params['width'] ) ) {
                        return false;
                }
+
                if ( !isset( $params['page'] ) ) {
                        $params['page'] = 1;
+               } else  {
+                       if ( $params['page'] > $image->pageCount() ) {
+                               $params['page'] = $image->pageCount();
+                       }
+
+                       if ( $params['page'] < 1 ) {
+                               $params['page'] = 1;
+                       }
                }
+
                $srcWidth = $image->getWidth( $params['page'] );
                $srcHeight = $image->getHeight( $params['page'] );
                if ( isset( $params['height'] ) && $params['height'] != -1 ) {
@@ -384,8 +395,11 @@ abstract class ImageHandler extends MediaHandler {
        /**
         * Validate thumbnail parameters and fill in the correct height
         *
-        * @param integer &$width Specified width (input/output)
-        * @param integer &$height Height (output only)
+        * @param $width Integer: specified width (input/output)
+        * @param $height Integer: height (output only)
+        * @param $srcWidth Integer: width of the source image
+        * @param $srcHeight Integer: height of the source image
+        * @param $mimeType Unused
         * @return false to indicate that an error should be returned to the user.
         */
        function validateThumbParams( &$width, &$height, $srcWidth, $srcHeight, $mimeType ) {
@@ -424,6 +438,10 @@ abstract class ImageHandler extends MediaHandler {
                return $gis;
        }
 
+       function isAnimatedImage( $image ) {
+               return false;
+       }
+
        function getShortDesc( $file ) {
                global $wgLang;
                $nbytes = wfMsgExt( 'nbytes', array( 'parsemag', 'escape' ),