1	<?php
2
3	namespace MediaWiki\Hook;
4
5	use MediaWiki\Title\Title;
6
7	/**
8	* This is a hook handler interface, see docs/Hooks.md.
9	* Use the hook name "ImgAuthBeforeStream" to register handlers implementing this interface.
10	*
11	* @stable to implement
12	* @ingroup Hooks
13	*/
14	interface ImgAuthBeforeStreamHook {
15	/**
16	* This hook is called before a file is streamed to a user, but only when using img_auth.php.
17	*
18	* @since 1.35
19	*
20	* @param Title &$title Title object of the file as it would appear for the upload page
21	* @param string &$path Original file and path name when img_auth was invoked by the web server
22	* @param string &$name Name only component of the file
23	* @param array &$result Location to pass back results of the hook routine (only used if
24	*   failed)
25	*   - $result[0]=The index of the header message
26	*   - $result[1]=The index of the body text message
27	*   - $result[2 through n]=Parameters passed to body text message. Please note the
28	*   header message cannot receive/use parameters.
29	* @return bool|void True or no return value to continue or false to abort
30	*/
31	public function onImgAuthBeforeStream( &$title, &$path, &$name, &$result );
32	}