aboutsummaryrefslogtreecommitdiffstats
path: root/includes/filerepo/Hook/FileTransformedHook.php
blob: 2f36dd87b40a1ec327aaa20799db62bf97fa92b7 (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
<?php

namespace MediaWiki\Hook;

use MediaTransformOutput;
use MediaWiki\FileRepo\File\File;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "FileTransformed" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface FileTransformedHook {
	/**
	 * This hook is called when a file is transformed and moved into storage.
	 *
	 * @since 1.35
	 *
	 * @param File $file Reference to the File object
	 * @param MediaTransformOutput $thumb
	 * @param string $tmpThumbPath Temporary file system path of the transformed file
	 * @param string $thumbPath Permanent storage path of the transformed file
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onFileTransformed( $file, $thumb, $tmpThumbPath, $thumbPath );
}