master/php/RestCheckCanExecuteHook_8php_source.html

<?php


namespace MediaWiki\Rest\Hook;


use MediaWiki\Api\Hook\ApiCheckCanExecuteHook;

use MediaWiki\Rest\Handler;

use MediaWiki\Rest\HttpException;

use MediaWiki\Rest\Module\Module;

use MediaWiki\Rest\RequestInterface;


interface RestCheckCanExecuteHook {

    public function onRestCheckCanExecute(

        Module $module,

        Handler $handler,

        string $path,

        RequestInterface $request,

        ?HttpException &$error

    ): bool;

}


$path
$path
Definition NoLocalSettings.php:28

MediaWiki\Rest\Handler
Base class for REST route handlers.
Definition Handler.php:25

MediaWiki\Rest\HttpException
This is the base exception class for non-fatal exceptions thrown from REST handlers.
Definition HttpException.php:12

MediaWiki\Rest\Module\Module
A REST module represents a collection of endpoints.
Definition Module.php:36

MediaWiki\Api\Hook\ApiCheckCanExecuteHook
This is a hook handler interface, see docs/Hooks.md.
Definition ApiCheckCanExecuteHook.php:17

MediaWiki\Rest\Hook\RestCheckCanExecuteHook
This is a hook handler interface, see docs/Hooks.md.
Definition RestCheckCanExecuteHook.php:19

MediaWiki\Rest\Hook\RestCheckCanExecuteHook\onRestCheckCanExecute
onRestCheckCanExecute(Module $module, Handler $handler, string $path, RequestInterface $request, ?HttpException &$error)
Called when initializing a REST API request.

MediaWiki\Rest\RequestInterface
A request interface similar to PSR-7's ServerRequestInterface.
Definition RequestInterface.php:39

MediaWiki\Rest\Handler
Copyright (C) 2011-2020 Wikimedia Foundation and others.
Definition ActionModuleBasedHandler.php:3

MediaWiki\Rest\Hook
Definition HookRunner.php:3