0

Final Class Yiisoft\Yii\Swagger\Action\SwaggerUi

All Classes | Methods
InheritanceYiisoft\Yii\Swagger\Action\SwaggerUi
ImplementsPsr\Http\Server\RequestHandlerInterface

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Yii\Swagger\Action\SwaggerUi
handle() Yiisoft\Yii\Swagger\Action\SwaggerUi
withJsonUrl() Yiisoft\Yii\Swagger\Action\SwaggerUi

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( \Yiisoft\Yii\View\Renderer\WebViewRenderer $viewRenderer, Yiisoft\Yii\Swagger\Service\SwaggerService $swaggerService, \Yiisoft\Assets\AssetManager $assetManager, array $params )
$viewRenderer \Yiisoft\Yii\View\Renderer\WebViewRenderer
$swaggerService Yiisoft\Yii\Swagger\Service\SwaggerService
$assetManager \Yiisoft\Assets\AssetManager
$params array 

                public function __construct(
    private readonly WebViewRenderer $viewRenderer,
    private readonly SwaggerService $swaggerService,
    private readonly AssetManager $assetManager,
    private readonly array $params,
) {}
handle() public method

public \Psr\Http\Message\ResponseInterface handle ( \Psr\Http\Message\ServerRequestInterface $request )
$request \Psr\Http\Message\ServerRequestInterface 

                public function handle(ServerRequestInterface $request): ResponseInterface
{
    $params = ArrayHelper::merge($this->defaultParams, $this->params);
    $params['url'] = $this->jsonUrl;
    return $this->viewRenderer
        ->withViewPath($this->swaggerService->getViewPath())
        ->renderPartial($this->swaggerService->getViewName(), [
            'assetManager' => $this->assetManager,
            'params' => $params,
        ]);
}
withJsonUrl() public method

public self withJsonUrl ( string $jsonUrl )
$jsonUrl string 

                public function withJsonUrl(string $jsonUrl): self
{
    $new = clone $this;
    $new->jsonUrl = $jsonUrl;
    return $new;
}