diff options
| author | Luke Shumaker <lukeshu@sbcglobal.net> | 2016-05-01 15:12:12 -0400 |
|---|---|---|
| committer | Luke Shumaker <lukeshu@sbcglobal.net> | 2016-05-01 15:12:12 -0400 |
| commit | c9aa36da061816dee256a979c2ff8d2ee41824d9 (patch) | |
| tree | 29f7002b80ee984b488bd047dbbd80b36bf892e9 /includes/api/ApiQueryStashImageInfo.php | |
| parent | b4274e0e33eafb5e9ead9d949ebf031a9fb8363b (diff) | |
| parent | d1ba966140d7a60cd5ae4e8667ceb27c1a138592 (diff) | |
Merge branch 'archwiki'
# Conflicts:
# skins/ArchLinux.php
# skins/ArchLinux/archlogo.gif
Diffstat (limited to 'includes/api/ApiQueryStashImageInfo.php')
| -rw-r--r-- | includes/api/ApiQueryStashImageInfo.php | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/includes/api/ApiQueryStashImageInfo.php b/includes/api/ApiQueryStashImageInfo.php index 6899375a..db928560 100644 --- a/includes/api/ApiQueryStashImageInfo.php +++ b/includes/api/ApiQueryStashImageInfo.php @@ -27,7 +27,7 @@ */ class ApiQueryStashImageInfo extends ApiQueryImageInfo { - public function __construct( $query, $moduleName ) { + public function __construct( ApiQuery $query, $moduleName ) { parent::__construct( $query, $moduleName, 'sii' ); } @@ -47,6 +47,7 @@ class ApiQueryStashImageInfo extends ApiQueryImageInfo { // Alias sessionkey to filekey, but give an existing filekey precedence. if ( !$params['filekey'] && $params['sessionkey'] ) { + $this->logFeatureUsage( 'prop=stashimageinfo&siisessionkey' ); $params['filekey'] = $params['sessionkey']; } @@ -60,7 +61,7 @@ class ApiQueryStashImageInfo extends ApiQueryImageInfo { $result->addValue( array( 'query', $this->getModuleName() ), null, $imageInfo ); $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), $modulePrefix ); } - //TODO: update exception handling here to understand current getFile exceptions + // @todo Update exception handling here to understand current getFile exceptions } catch ( UploadStashNotAvailableException $e ) { $this->dieUsage( "Session not available: " . $e->getMessage(), "nosession" ); } catch ( UploadStashFileNotFoundException $e ) { @@ -72,7 +73,7 @@ class ApiQueryStashImageInfo extends ApiQueryImageInfo { private $propertyFilter = array( 'user', 'userid', 'comment', 'parsedcomment', - 'mediatype', 'archivename', + 'mediatype', 'archivename', 'uploadwarning', ); public function getAllowedParams() { @@ -108,10 +109,11 @@ class ApiQueryStashImageInfo extends ApiQueryImageInfo { /** * Return the API documentation for the parameters. - * @return Array parameter documentation. + * @return array Parameter documentation. */ public function getParamDescription() { $p = $this->getModulePrefix(); + return array( 'prop' => self::getPropertyDescriptions( $this->propertyFilter, $p ), 'filekey' => 'Key that identifies a previous upload that was stashed temporarily.', @@ -123,19 +125,15 @@ class ApiQueryStashImageInfo extends ApiQueryImageInfo { ); } - public function getResultProperties() { - return ApiQueryImageInfo::getResultPropertiesFiltered( $this->propertyFilter ); - } - public function getDescription() { - return 'Returns image information for stashed images'; + return 'Returns image information for stashed images.'; } public function getExamples() { return array( 'api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567', - 'api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url', + 'api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&' . + 'siiurlwidth=120&siiprop=url', ); } - } |