AirLay backend

KeycloakController extends ApiController
in package

Class ApiBaseController.

Table of Contents

$config  : AirlayConfig
$config  : AirlayConfig
$dataLoader  : DataLoaderEntity
$request  : Request
$user  : UserEntity
$keycloakHandler  : KeycloakHandler|null
$status  : StatusPage|null
$tokenHandler  : TokenHandler|null
__destruct()  : mixed
afterExecuteRoute()  : mixed
authAction()  : void
Keycloak user authorization request( 'method' => 'GET', 'url' => '/api/v4/keycloak/auth', 'params' => [] )
beforeExecuteRoute()  : mixed
indexAction()  : mixed
initialize()  : void
pingAction()  : string
Keycloak health check request( 'method' => 'GET', 'url' => '/api/v4/keycloak/ping', 'params' => [] )
attachTmpFile()  : Response
firesAnRelationUpdateEvents()  : void
getId()  : int|string
getNormalizedUserId()  : int|ObjectId
getTranslator()  : NativeArray
getUserInfo()  : UserEntity
secureData()  : mixed
sendEmail()  : mixed
getRedirectUrl()  : string

Properties

Methods

afterExecuteRoute()

public afterExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
$dispatcher : Dispatcher
Return values
mixed —

authAction()

Keycloak user authorization request( 'method' => 'GET', 'url' => '/api/v4/keycloak/auth', 'params' => [] )

public authAction() : void
Return values
void —

beforeExecuteRoute()

public beforeExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
$dispatcher : Dispatcher
Return values
mixed —

pingAction()

Keycloak health check request( 'method' => 'GET', 'url' => '/api/v4/keycloak/ping', 'params' => [] )

public pingAction() : string
Return values
string —

firesAnRelationUpdateEvents()

protected firesAnRelationUpdateEvents(array<string|int, mixed> $relations, ObjectId $dataSetId[, DataSetLogEntity|null $log = null ]) : void
Parameters
$relations : array<string|int, mixed>
$dataSetId : ObjectId
$log : DataSetLogEntity|null = null
Return values
void —

getTranslator()

protected getTranslator([string|null $language = null ]) : NativeArray
Parameters
$language : string|null = null
Tags
throws
Exception
Return values
NativeArray —

getUserInfo()

protected getUserInfo() : UserEntity
Tags
throws
Exception
Return values
UserEntity —

secureData()

protected secureData(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed —

sendEmail()

protected sendEmail(string $email, string $name, string $subject, string $body) : mixed
Parameters
$email : string
$name : string
$subject : string
$body : string
Return values
mixed —

getRedirectUrl()

private getRedirectUrl(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>
Return values
string —

Search results