[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/media/ -> ImageHandler.php (summary)

Media-handling base classes and generic functionality. 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 the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 288 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 15 functions

  canRender()
  getParamMap()
  validateParam()
  makeParamString()
  parseParamString()
  getScriptParams()
  normaliseParams()
  validateThumbParams()
  getScriptedTransform()
  getImageSize()
  getImageArea()
  getShortDesc()
  getLongDesc()
  getDimensionsString()
  sanitizeParamsForBucketing()

Functions
Functions that are not part of a class:

canRender( $file )   X-Ref

param: File $file
return: bool

getParamMap()   X-Ref
No description

validateParam( $name, $value )   X-Ref
No description

makeParamString( $params )   X-Ref
No description

parseParamString( $str )   X-Ref
No description

getScriptParams( $params )   X-Ref
No description

normaliseParams( $image, &$params )   X-Ref

param: File $image
param: array $params
return: bool

validateThumbParams( &$width, &$height, $srcWidth, $srcHeight, $mimeType )   X-Ref
Validate thumbnail parameters and fill in the correct height

param: int $width Specified width (input/output)
param: int $height Height (output only)
param: int $srcWidth Width of the source image
param: int $srcHeight Height of the source image
param: string $mimeType Unused
return: bool False to indicate that an error should be returned to the user.

getScriptedTransform( $image, $script, $params )   X-Ref

param: File $image
param: string $script
param: array $params
return: bool|MediaTransformOutput

getImageSize( $image, $path )   X-Ref
No description

getImageArea( $image )   X-Ref
Function that returns the number of pixels to be thumbnailed.
Intended for animated GIFs to multiply by the number of frames.

If the file doesn't support a notion of "area" return 0.

param: File $image
return: int

getShortDesc( $file )   X-Ref

param: File $file
return: string

getLongDesc( $file )   X-Ref

param: File $file
return: string

getDimensionsString( $file )   X-Ref

param: File $file
return: string

sanitizeParamsForBucketing( $params )   X-Ref
No description



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1