blob: 206010610d77ed731858e2d3ebd544571c2e1f76 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
<?php
namespace MediaWiki\Hook;
use MediaWiki\Context\IContextSource;
use MediaWiki\FileRepo\File\File;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "GetExtendedMetadata" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface GetExtendedMetadataHook {
/**
* Use this hook to get extended file metadata for the API.
*
* @since 1.35
*
* @param array &$combinedMeta Array of the form:
* 'MetadataPropName' => [
* value' => prop value,
* 'source' => 'name of hook'
* ]
* @param File $file File in question
* @param IContextSource $context RequestContext (including language to use)
* @param bool $single Only extract the current language; if false, the prop value should
* be in the metadata multi-language array format:
* https://mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
* @param int &$maxCacheTime How long the results can be cached
* @return bool|void True or no return value to continue or false to abort
*/
public function onGetExtendedMetadata( &$combinedMeta, $file, $context,
$single, &$maxCacheTime
);
}
|
