wiki.techinc.nl/includes/session/Hook/SessionCheckInfoHook.php
2020-10-02 16:15:21 +00:00

33 lines
1 KiB
PHP

<?php
namespace MediaWiki\Session\Hook;
use MediaWiki\Session\SessionInfo;
use WebRequest;
/**
* 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
);
}