ReportTemplateController
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
- createAction() : string
- Create report template request( 'method' => 'Post', 'url' => '/api/v4/report_template/create', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'report template name', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'description' => 'report template type', 'required' => true ], [ 'name' => 'file', 'type' => 'File', 'description' => 'report in xls format', 'required' => true ], [ 'name' => 'groupField', 'type' => 'string', 'description' => 'group field', 'required' => false ], [ 'name' => 'fieldForZip', 'type' => 'string', 'description' => 'field for name of files in zip, in individual report', 'required' => false ], [ 'name' => 'template', 'type' => 'json', 'description' => 'template of paths for name of files in zip, in media report', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => ReportTemplateEntity, 'code' => 0 ])
- deleteAction() : string
- Delete report template request( 'method' => 'Post', 'url' => '/api/v4/report_template/delete', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'report template id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'Ok', 'code' => 0 ])
- downloadAction() : Response
- Download report template file request([ 'method' => 'Post', 'url' => '/api/v4/report_template/download', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'report template id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'Ok', 'code' => 0 ])
- getAction() : string
- Get report templates request([ 'method' => 'GET', 'url' => '/api/v4/report_template/get' 'params' => [ ] ]) response([ 'status' => 200, 'message' => ReportTemplateEntity[], 'code' => 0 ])
- indexAction() : mixed
- initialize() : void
- updateAction() : string
- Update report template name request([ 'method' => 'POST', 'url' => '/api/v4/report_template/update' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'report template id', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'description' => 'report template name', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'description' => 'report template name', 'required' => true ], [ 'name' => 'file', 'type' => 'File', 'description' => 'report in xls/xlsx format', 'required' => true ], [ 'name' => 'groupField', 'type' => 'string', 'description' => 'group field', 'required' => false ], [ 'name' => 'fieldForZip', 'type' => 'string', 'description' => 'field for name of files in zip, in individual report', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => ReportTemplateEntity, '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 —createAction()
Create report template request( 'method' => 'Post', 'url' => '/api/v4/report_template/create', 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'report template name', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'description' => 'report template type', 'required' => true ], [ 'name' => 'file', 'type' => 'File', 'description' => 'report in xls format', 'required' => true ], [ 'name' => 'groupField', 'type' => 'string', 'description' => 'group field', 'required' => false ], [ 'name' => 'fieldForZip', 'type' => 'string', 'description' => 'field for name of files in zip, in individual report', 'required' => false ], [ 'name' => 'template', 'type' => 'json', 'description' => 'template of paths for name of files in zip, in media report', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => ReportTemplateEntity, 'code' => 0 ])
public
createAction() : string
Tags
Return values
string —deleteAction()
Delete report template request( 'method' => 'Post', 'url' => '/api/v4/report_template/delete', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'report template id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'Ok', 'code' => 0 ])
public
deleteAction() : string
Tags
Return values
string —downloadAction()
Download report template file request([ 'method' => 'Post', 'url' => '/api/v4/report_template/download', 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'report template id', 'required' => true ] ] ]) response([ 'status' => 200, 'message' => 'Ok', 'code' => 0 ])
public
downloadAction() : Response
Tags
Return values
Response —getAction()
Get report templates request([ 'method' => 'GET', 'url' => '/api/v4/report_template/get' 'params' => [ ] ]) response([ 'status' => 200, 'message' => ReportTemplateEntity[], 'code' => 0 ])
public
getAction() : string
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —updateAction()
Update report template name request([ 'method' => 'POST', 'url' => '/api/v4/report_template/update' 'params' => [ [ 'name' => 'id', 'type' => 'objectId', 'description' => 'report template id', 'required' => true ], [ 'name' => 'name', 'type' => 'string', 'description' => 'report template name', 'required' => true ], [ 'name' => 'type', 'type' => 'string', 'description' => 'report template name', 'required' => true ], [ 'name' => 'file', 'type' => 'File', 'description' => 'report in xls/xlsx format', 'required' => true ], [ 'name' => 'groupField', 'type' => 'string', 'description' => 'group field', 'required' => false ], [ 'name' => 'fieldForZip', 'type' => 'string', 'description' => 'field for name of files in zip, in individual report', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => ReportTemplateEntity, 'code' => 0 ])
public
updateAction() : 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