AirLay backend

FilterController extends ApiController
in package

Class ApiBaseController.

Table of Contents

$config  : AirlayConfig
$config  : AirlayConfig
$request  : Request
$user  : UserEntity
$status  : StatusPage|null
$tokenHandler  : TokenHandler|null
__destruct()  : mixed
addDataSetAction()  : string
Add data set request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/addDataSet' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])
addItemAction()  : string
Add item.
afterExecuteRoute()  : mixed
beforeExecuteRoute()  : mixed
createAction()  : string
Create filter request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/create' 'parameters' => [ [ 'name' => 'name', 'type' => 'string', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = FilterEntity, 'code' = 0 ])
deleteAction()  : string
Delete filter request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/delete' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])
getAction()  : string
Get filters request([ 'method' => 'GET' 'url' => '/api/v4/administration/filter/get' ]) response ([ 'status' = 200, 'message' = FilterEntity[], 'code' = 0 ])
indexAction()  : mixed
initialize()  : void
removeDataSetAction()  : string
Remove data set request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/removeDataSet' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])
removeItemAction()  : string
Remove item request([ 'method' => 'POST' 'url' => '/api/v4/administration/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 ])
replaceItemAction()  : string
Replace item request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/replaceItem' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'oldField', 'type' => 'string', 'required' => true ], [ 'name' => 'oldType', '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 ] ] ]) response ([ 'status' = 200, 'message' = 'OK', '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 request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/addDataSet' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])

public addDataSetAction() : string
Tags
throws
AirlayException
Return values
string

addItemAction()

Add item.

public addItemAction() : string

request([ 'method' => 'POST' 'url' => '/api/v4/administration/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 ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])

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 filter request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/create' 'parameters' => [ [ 'name' => 'name', 'type' => 'string', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = FilterEntity, 'code' = 0 ])

public createAction() : string
Tags
throws
AirlayException
Return values
string

deleteAction()

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

public deleteAction() : string
Tags
throws
AirlayException
Return values
string

getAction()

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

public getAction() : string
Return values
string

removeDataSetAction()

Remove data set request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/removeDataSet' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => true ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])

public removeDataSetAction() : string
Tags
throws
AirlayException
Return values
string

removeItemAction()

Remove item request([ 'method' => 'POST' 'url' => '/api/v4/administration/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 ])

public removeItemAction() : string
Tags
throws
AirlayException
Return values
string

replaceItemAction()

Replace item request([ 'method' => 'POST' 'url' => '/api/v4/administration/filter/replaceItem' 'parameters' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'oldField', 'type' => 'string', 'required' => true ], [ 'name' => 'oldType', '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 ] ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ])

public replaceItemAction() : string
Tags
throws
AirlayException
Return values
string

updateNameAction()

Update name.

public updateNameAction() : string

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

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