CategoryController
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
- afterExecuteRoute() : mixed
- beforeExecuteRoute() : mixed
- copyAction() : string
- Copy category request([ 'method' => 'POST', 'url' => '/api/v4/category/copy' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
- createAction() : string
- Create category request([ 'method' => 'POST', 'url' => '/api/v4/category/create', 'rawData' => 'CategoryEntity' ]) response([ 'status' => '200', 'message' => CategoryEntity, 'code' => 0 ])
- deleteAction() : string
- Delete category request([ 'method' => 'POST', 'url' => '/api/v4/category/delete' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
- downloadAction() : void
- Download categories request( 'method' => 'GET', 'url' => '/api/v4/category/download', 'params' => [] ) response( '200' => [ 'status' => 200, 'message' => File, 'code' => 0 ] )
- getAction() : string
- Get category by data set id request([ 'method' => 'GET', 'url' => '/api/v4/category/get', 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'id of data set' 'required' => true ] ] ]) response([ 'status' => 200, 'message' => CategoryEntity[], 'code' => 0 ])
- getCustomCategoriesAction() : string
- Get custom categories request([ 'method' => 'GET', 'url' => '/api/v4/category/getCustomCategories', 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'id of data set' 'required' => true ] ] ])
- indexAction() : mixed
- initialize() : void
- updateAction() : string
- Update category request([ 'method' => 'POST', 'url' => '/api/v4/category/create', 'rawData' => 'CategoryEntity' ]) response([ 'status' => '200', 'message' => CategoryEntity, 'code' => 0 ])
- uploadAction() : string
- Upload categories request( 'method' => 'POST', 'url' => '/api/v4/category/upload', 'params' => [ [ 'name' => 'file', 'type' => 'File', 'description' => 'json file with layers', 'require' => true ], [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => Ok, 'code' => 0 ] )
- attachTmpFile() : Response
- firesAnRelationUpdateEvents() : void
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- secureData() : mixed
- sendEmail() : mixed
Properties
$config
public
AirlayConfig
$config
$config
public
AirlayConfig
$config
$request
public
Request
$request
$user
public
UserEntity
$user
$status
protected
StatusPage|null
$status
$tokenHandler
protected
TokenHandler|null
$tokenHandler
Methods
__destruct()
public
__destruct() : mixed
Return values
mixed —afterExecuteRoute()
public
afterExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
- $dispatcher : Dispatcher
Return values
mixed —beforeExecuteRoute()
public
beforeExecuteRoute(Dispatcher $dispatcher) : mixed
Parameters
- $dispatcher : Dispatcher
Return values
mixed —copyAction()
Copy category request([ 'method' => 'POST', 'url' => '/api/v4/category/copy' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
public
copyAction() : string
Tags
Return values
string —createAction()
Create category request([ 'method' => 'POST', 'url' => '/api/v4/category/create', 'rawData' => 'CategoryEntity' ]) response([ 'status' => '200', 'message' => CategoryEntity, 'code' => 0 ])
public
createAction() : string
Tags
Return values
string —deleteAction()
Delete category request([ 'method' => 'POST', 'url' => '/api/v4/category/delete' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'OK', 'code' => 0 ])
public
deleteAction() : string
Tags
Return values
string —downloadAction()
Download categories request( 'method' => 'GET', 'url' => '/api/v4/category/download', 'params' => [] ) response( '200' => [ 'status' => 200, 'message' => File, 'code' => 0 ] )
public
downloadAction() : void
Tags
Return values
void —getAction()
Get category by data set id request([ 'method' => 'GET', 'url' => '/api/v4/category/get', 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'id of data set' 'required' => true ] ] ]) response([ 'status' => 200, 'message' => CategoryEntity[], 'code' => 0 ])
public
getAction() : string
Tags
Return values
string —getCustomCategoriesAction()
Get custom categories request([ 'method' => 'GET', 'url' => '/api/v4/category/getCustomCategories', 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'id of data set' 'required' => true ] ] ])
public
getCustomCategoriesAction() : string
response([ 'status' => 200, 'message' => CategoryEntity[], 'code' => 0 ])
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —updateAction()
Update category request([ 'method' => 'POST', 'url' => '/api/v4/category/create', 'rawData' => 'CategoryEntity' ]) response([ 'status' => '200', 'message' => CategoryEntity, 'code' => 0 ])
public
updateAction() : string
Tags
Return values
string —uploadAction()
Upload categories request( 'method' => 'POST', 'url' => '/api/v4/category/upload', 'params' => [ [ 'name' => 'file', 'type' => 'File', 'description' => 'json file with layers', 'require' => true ], [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'require' => true ] ] ) response( '200' => [ 'status' => 200, 'message' => Ok, 'code' => 0 ] )
public
uploadAction() : string
Tags
Return values
string —attachTmpFile()
protected
attachTmpFile(TmpFile $tmpFile) : Response
Parameters
- $tmpFile : TmpFile
Return values
Response —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 —getId()
protected
getId() : mixed
Return values
mixed —getNormalizedUserId()
protected
getNormalizedUserId() : int|ObjectId
Tags
Return values
int|ObjectId —getTranslator()
protected
getTranslator([string|null $language = null ]) : NativeArray
Parameters
- $language : string|null = null
Tags
Return values
NativeArray —getUserInfo()
protected
getUserInfo() : UserEntity
Tags
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