File: SessionCheckInfoHook.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (33 lines) | stat: -rw-r--r-- 1,049 bytes parent folder | download
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
<?php

namespace MediaWiki\Session\Hook;

use MediaWiki\Request\WebRequest;
use MediaWiki\Session\SessionInfo;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "SessionCheckInfo" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface SessionCheckInfoHook {
	/**
	 * Use this hook to validate a MediaWiki\Session\SessionInfo as it's being
	 * loaded from storage.
	 *
	 * @since 1.35
	 *
	 * @param string &$reason Rejection reason to be logged
	 * @param SessionInfo $info MediaWiki\Session\SessionInfo being validated
	 * @param WebRequest $request WebRequest being loaded from
	 * @param array|bool $metadata Metadata array for the MediaWiki\Session\Session
	 * @param array|bool $data Data array for the MediaWiki\Session\Session
	 * @return bool|void True or no return value to continue, or false to prevent
	 *   the MediaWiki\Session\SessionInfo from being used
	 */
	public function onSessionCheckInfo( &$reason, $info, $request, $metadata,
		$data
	);
}