AirLay backend

FilterController extends ApiController
in package

Class FilterController

Table of Contents

$config  : AirlayConfig
$config  : AirlayConfig
$request  : Request
$user  : UserEntity
$status  : StatusPage|null
$tokenHandler  : TokenHandler|null
__destruct()  : mixed
addDataSetAction()  : string
Add data set.
addItemAction()  : string
Add item.
afterExecuteRoute()  : mixed
beforeExecuteRoute()  : mixed
createAction()  : string
Create.
deleteAction()  : string
Delete filter.
getAction()  : string
Get filters.
getAvailableAction()  : string
Get available filters.
getByDataSetIdAction()  : string
Get filters by data set id.
indexAction()  : mixed
initialize()  : void
removeDataSetAction()  : string
Remove data set.
removeItemAction()  : string
Remove item.
replaceItemAction()  : string
Replace item.
setFilterByIssuesAction()  : string
Set filter by issues request([ 'method' => 'GET' 'url' => '/api/v3/filter/setFilterByIssues' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'filterByIssues', 'type' => 'bool', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = FilterEntity, 'code' = 0 ])
updateNameAction()  : string
Update name.
attachTmpFile()  : Response
firesAnRelationUpdateEvents()  : void
getId()  : mixed
getNormalizedUserId()  : int|ObjectId
getTranslator()  : NativeArray
getUserInfo()  : UserEntity
secureData()  : mixed
sendEmail()  : mixed
extractFilter()  : FilterEntity

Properties

Methods

addDataSetAction()

Add data set.

public addDataSetAction() : string

request([ 'method' => 'POST' 'url' => '/api/v3/filter/addDataSet' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ] ])

Tags
throws
AirlayException
Return values
string —

addItemAction()

Add item.

public addItemAction() : string

request([ 'method' => 'POST' 'url' => '/api/v3/filter/addItem' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'field', 'type' => 'string', 'required' => true ], [ 'name' => 'type', 'type' => 'number' | 'string' | 'date', 'required' => true ], [ 'name' => 'alias', 'type' => 'string', 'required' => false ], [ 'name' => 'default', 'type' => 'string', 'required' => false ], [ 'name' => 'player', 'type' => 'string', 'required' => false ] ] ])

Tags
throws
AirlayException
Return values
string —

afterExecuteRoute()

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

beforeExecuteRoute()

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

createAction()

Create.

public createAction() : string

request([ 'method' => 'POST' 'url' => '/api/v3/filter/create' 'parameters' => [ [ 'name' => 'name', 'type' => 'string', 'required' => true ] ] ])

Tags
throws
AirlayException
Return values
string —

deleteAction()

Delete filter.

public deleteAction() : string

request([ 'method' => 'POST' 'url' => '/api/v3/filter/delete' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])

Tags
throws
AirlayException
Return values
string —

getAction()

Get filters.

public getAction() : string

request([ 'method' => 'GET' 'url' => '/api/v3/filter/get' ]) response ([ 'status' = 200, 'message' = FilterEntity[], 'code' = 0 ])

Return values
string —

getAvailableAction()

Get available filters.

public getAvailableAction() : string

request([ 'method' => 'GET' 'url' => '/api/v3/filter/getAvailable' ]) response ([ 'status' = 200, 'message' = FilterEntity[], 'code' = 0 ])

Return values
string —

getByDataSetIdAction()

Get filters by data set id.

public getByDataSetIdAction() : string

request([ 'method' => 'GET' 'url' => '/api/v3/filter/getByDataSetId' 'parameters' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = FilterEntity[], 'code' = 0 ])

Tags
throws
AirlayException
Return values
string —

removeDataSetAction()

Remove data set.

public removeDataSetAction() : string

request([ 'method' => 'POST' 'url' => '/api/v3/filter/removeDataSet' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ] ])

Tags
throws
AirlayException
Return values
string —

removeItemAction()

Remove item.

public removeItemAction() : string

request([ 'method' => 'POST' 'url' => '/api/v3/filter/removeItem' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'field', 'type' => 'string', 'required' => true ], [ 'name' => 'type', 'type' => 'number' | 'string' | 'date', 'required' => true ], [ 'name' => 'alias', 'type' => 'string', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])

Tags
throws
AirlayException
Return values
string —

replaceItemAction()

Replace item.

public replaceItemAction() : string

request([ 'method' => 'POST' 'url' => '/api/v3/filter/replaceItem' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'oldField', 'type' => 'string', 'required' => true ], [ 'name' => 'oldType', 'type' => 'number' | 'string' | 'date', 'required' => true ], [ 'name' => 'oldDefaultValue', 'type' => 'number' | 'string' | 'date', 'required' => true ], [ 'name' => 'oldPlayer', 'type' => 'number' | 'string' | 'date', 'required' => true ], [ 'name' => 'oldAlias', 'type' => 'string', 'required' => true ], [ 'name' => 'field', 'type' => 'string', 'required' => true ], [ 'name' => 'type', 'type' => 'number' | 'string' | 'date', 'required' => true ], [ 'name' => 'alias', 'type' => 'string', 'required' => false ], [ 'name' => 'defaultValue', 'type' => 'string', 'required' => false ], [ 'name' => 'player', 'type' => 'string', 'required' => false ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])

Tags
throws
AirlayException
Return values
string —

setFilterByIssuesAction()

Set filter by issues request([ 'method' => 'GET' 'url' => '/api/v3/filter/setFilterByIssues' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'filterByIssues', 'type' => 'bool', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = FilterEntity, 'code' = 0 ])

public setFilterByIssuesAction() : string
Tags
throws
AirlayException
Return values
string —

updateNameAction()

Update name.

public updateNameAction() : string

request([ 'method' => 'POST' 'url' => '/api/v3/filter/updateName' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'required' => true ] ] ])

Tags
throws
AirlayException
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 —

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 —

Search results