PHP Class Flarum\Api\Client

Show file Open project: flarum/core Class Usage Examples

Protected Properties

Property	Type	Description
$container	Illuminate\Contracts\Container\Container
$errorHandler	ErrorHandler

Public Methods

Method	Description
__construct ( Illuminate\Contracts\Container\Container $container, ErrorHandler $errorHandler )
send ( string \| Flarum\Http\Controller\ControllerInterface $controller, User \| null $actor, array $queryParams = [], array $body = [] ) : Psr\Http\Message\ResponseInterface	Execute the given API action class, pass the input and return its response.

Method Details

__construct() public method

public __construct ( Illuminate\Contracts\Container\Container $container, ErrorHandler $errorHandler )
$container	Illuminate\Contracts\Container\Container
$errorHandler	ErrorHandler

send() public method

Execute the given API action class, pass the input and return its response.

public send ( string \| Flarum\Http\Controller\ControllerInterface $controller, User \| null $actor, array $queryParams = [], array $body = [] ) : Psr\Http\Message\ResponseInterface
$controller	string \| Flarum\Http\Controller\ControllerInterface
$actor	Flarum\Core\User \| null
$queryParams	array
$body	array
return	Psr\Http\Message\ResponseInterface

Property Details

$container protected property

protected Container,Illuminate\Contracts\Container $container
return	Illuminate\Contracts\Container\Container

$errorHandler protected property

protected ErrorHandler,Flarum\Api $errorHandler
return	ErrorHandler