ModuleController
extends BaseController
in package
FinalYes
Table of Contents
Properties
- $flash : FlashMessengerInterface
- $renderer : ViewRendererInterface
- $requestContext : RequestContext
- $logger : LoggerInterface
- $request : ServerRequestInterface
- $toggleModuleUseCase : ToggleModuleUseCase
- $translator : Translator
- $updateModuleUseCase : UpdateModuleUseCase
Methods
- __construct() : mixed
- toggle() : ResponseInterface
- Toggle module via API POST /api/module/{id}/toggle
- update() : ResponseInterface
- Update module via API PATCH /api/module/{id}
- flash() : void
- getCurrentUserId() : int|null
- jsonResponse() : ResponseInterface
- JSON response helper
- noContentResponse() : ResponseInterface
- No content response helper
- redirect() : ResponseInterface
- Redirect to URL
- render() : ResponseInterface
- Render view and return as response
Properties
$flash
public
FlashMessengerInterface
$flash
$renderer
public
ViewRendererInterface
$renderer
$requestContext
public
RequestContext
$requestContext
$logger read-only
private
LoggerInterface
$logger
$request read-only
private
ServerRequestInterface
$request
$toggleModuleUseCase read-only
private
ToggleModuleUseCase
$toggleModuleUseCase
$translator read-only
private
Translator
$translator
$updateModuleUseCase read-only
private
UpdateModuleUseCase
$updateModuleUseCase
Methods
__construct()
public
__construct(RequestContext $requestContext, ViewRendererInterface $renderer, ServerRequestInterface $request, LoggerInterface $logger, Translator $translator, ToggleModuleUseCase $toggleModuleUseCase, UpdateModuleUseCase $updateModuleUseCase) : mixed
Parameters
- $requestContext : RequestContext
- $renderer : ViewRendererInterface
- $request : ServerRequestInterface
- $logger : LoggerInterface
- $translator : Translator
- $toggleModuleUseCase : ToggleModuleUseCase
- $updateModuleUseCase : UpdateModuleUseCase
toggle()
Toggle module via API POST /api/module/{id}/toggle
public
toggle([array<string|int, mixed> $vars = [] ]) : ResponseInterface
Parameters
- $vars : array<string|int, mixed> = []
Tags
Return values
ResponseInterfaceupdate()
Update module via API PATCH /api/module/{id}
public
update([array<string|int, mixed> $vars = [] ]) : ResponseInterface
Parameters
- $vars : array<string|int, mixed> = []
Tags
Return values
ResponseInterfaceflash()
protected
flash(string $key, string $message) : void
Parameters
- $key : string
- $message : string
getCurrentUserId()
protected
getCurrentUserId() : int|null
Tags
Return values
int|nulljsonResponse()
JSON response helper
protected
jsonResponse(int $statusCode, array<string|int, mixed> $data) : ResponseInterface
Parameters
- $statusCode : int
- $data : array<string|int, mixed>
Return values
ResponseInterfacenoContentResponse()
No content response helper
protected
noContentResponse([int $statusCode = 204 ]) : ResponseInterface
Parameters
- $statusCode : int = 204
Return values
ResponseInterfaceredirect()
Redirect to URL
protected
redirect(string $location[, int $statusCode = 302 ]) : ResponseInterface
Parameters
- $location : string
- $statusCode : int = 302
Return values
ResponseInterfacerender()
Render view and return as response
protected
render(string $view[, array<string|int, mixed> $data = [] ][, int $statusCode = 200 ]) : ResponseInterface
Parameters
- $view : string
- $data : array<string|int, mixed> = []
- $statusCode : int = 200