[ PHPXref.com ] [ Generated: Thu Jul 24 15:14:57 2008 ] [ MediaWiki 1.8.2 ]
[ Index ]     [ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/includes/ -> ImageFunctions.php (summary)

(no description)

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

Defines 10 functions

  wfImageDir()
  wfImageThumbDir()
  wfDeprecatedThumbDir()
  wfImageArchiveDir()
  wfGetHashPath()
  wfImageArchiveUrl()
  wfScaleSVGUnit()
  wfGetSVGsize()
  wfIsBadImage()
  wfFitBoxWidth()

Functions
Functions that are not part of a class:

wfImageDir( $fname )   X-Ref
Returns the image directory of an image
The result is an absolute path.

This function is called from thumb.php before Setup.php is included

param: $fname String: file name of the image file.

wfImageThumbDir( $fname, $shared = false )   X-Ref
Returns the image directory of an image's thubnail
The result is an absolute path.

This function is called from thumb.php before Setup.php is included

param: $fname String: file name of the original image file
param: $shared Boolean: (optional) use the shared upload directory (default: 'false').

wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false)   X-Ref
Old thumbnail directory, kept for conversion


wfImageArchiveDir( $fname , $subdir='archive', $shared=false )   X-Ref
Returns the image directory of an image's old version
The result is an absolute path.

This function is called from thumb.php before Setup.php is included

param: $fname String: file name of the thumbnail file, including file size prefix.
param: $subdir String: subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'.
param: $shared Boolean use the shared upload directory (only relevant for other functions which call this one). Default is 'false'.

wfGetHashPath( $dbkey, $fromSharedDirectory = false )   X-Ref
No description

wfImageArchiveUrl( $name, $subdir='archive' )   X-Ref
Returns the image URL of an image's old version

param: $name String: file name of the image file
param: $subdir String: (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'

wfScaleSVGUnit( $length )   X-Ref
Return a rounded pixel equivalent for a labeled CSS/SVG length.
http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers

param: $length String: CSS/SVG length.
return: Integer: length in pixels

wfGetSVGsize( $filename )   X-Ref
Compatible with PHP getimagesize()

param: $filename String: full name of the file (passed to php fopen()).
return: array

wfIsBadImage( $name, $contextTitle = false )   X-Ref
Determine if an image exists on the 'bad image list'.

The format of MediaWiki:Bad_image_list is as follows:
* Only list items (lines starting with "*") are considered
* The first link on a line must be a link to a bad image
* Any subsequent links on the same line are considered to be exceptions,
i.e. articles where the image may occur inline.

param: string $name the image name to check
param: Title $contextTitle The page on which the image occurs, if known
return: bool

wfFitBoxWidth( $boxWidth, $boxHeight, $maxHeight )   X-Ref
Calculate the largest thumbnail width for a given original file size
such that the thumbnail's height is at most $maxHeight.

param: $boxWidth Integer Width of the thumbnail box.
param: $boxHeight Integer Height of the thumbnail box.
param: $maxHeight Integer Maximum height expected for the thumbnail.
return: Integer.



[ Powered by PHPXref - Served by Debian GNU/Linux ]