| [ Index ] |
PHP Cross Reference of MediaWiki-1.24.0 |
[Source view] [Print] [Project Stats]
Created on July 6, 2007 Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
| File Size: | 799 lines (26 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ApiQueryImageInfo:: (18 methods):
__construct()
execute()
getScale()
mergeThumbParams()
checkParameterNormalise()
getInfo()
getTransformCount()
processMetaData()
getCacheMode()
getContinueStr()
getAllowedParams()
getPropertyNames()
getProperties()
getPropertyDescriptions()
getParamDescription()
getDescription()
getExamples()
getHelpUrls()
Class: ApiQueryImageInfo - X-Ref
A query action to get image information and upload history.| __construct( ApiQuery $query, $moduleName, $prefix = 'ii' ) X-Ref |
| No description |
| execute() X-Ref |
| No description |
| getScale( $params ) X-Ref |
| From parameters, construct a 'scale' array param: array $params Parameters passed to api. return: array|null Key-val array of 'width' and 'height', or null |
| mergeThumbParams( $image, $thumbParams, $otherParams ) X-Ref |
| No description |
| checkParameterNormalise( $image, $finalParams ) X-Ref |
| Verify that the final image parameters can be normalised. This doesn't use the normalised parameters, since $file->transform expects the pre-normalised parameters, but doing the normalisation allows us to catch certain error conditions early (such as missing required parameter). param: $image File param: $finalParams array List of parameters to transform image with |
| getInfo( $file, $prop, $result, $thumbParams = null, $opts = false ) X-Ref |
| Get result information for an image revision param: File $file param: array $prop Array of properties to get (in the keys) param: ApiResult $result param: array $thumbParams Containing 'width' and 'height' items, or null param: array|bool|string $opts Options for data fetching. return: array Result array |
| getTransformCount() X-Ref |
| Get the count of image transformations performed If this is >= TRANSFORM_LIMIT, you should probably stop processing images. return: int Count |
| processMetaData( $metadata, $result ) X-Ref |
param: array $metadata param: ApiResult $result return: array |
| getCacheMode( $params ) X-Ref |
| No description |
| getContinueStr( $img, $start = null ) X-Ref |
param: File $img param: null|string $start return: string |
| getAllowedParams() X-Ref |
| No description |
| getPropertyNames( $filter = array() X-Ref |
| Returns all possible parameters to iiprop param: array $filter List of properties to filter out return: array |
| getProperties( $modulePrefix = '' ) X-Ref |
| Returns array key value pairs of properties and their descriptions param: string $modulePrefix return: array |
| getPropertyDescriptions( $filter = array() X-Ref |
| Returns the descriptions for the properties provided by getPropertyNames() param: array $filter List of properties to filter out param: string $modulePrefix return: array |
| getParamDescription() X-Ref |
| Return the API documentation for the parameters. return: array Parameter documentation. |
| getDescription() X-Ref |
| No description |
| getExamples() X-Ref |
| No description |
| getHelpUrls() X-Ref |
| No description |
| Generated: Fri Nov 28 14:03:12 2014 | Cross-referenced by PHPXref 0.7.1 |