DataloaderController
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|false
- Post create dataloader.
- deleteAction() : string|false
- Post delete dataloader.
- getAction() : string|false
- Get data loaders.
- getUserFromPost() : UserEntity|null
- indexAction() : mixed
- initialize() : void
- sendAction() : string
- POST Action for send data to DataLoader param raw data $body Upload data param ObjectId $dataSetId DataSet id param string $updatePropertiesStrategy Update Properties Strategy may be "replace" or "merge"
- updateAction() : string|false
- Post update dataloader.
- attachTmpFile() : Response
- createObjectId() : ObjectId
- firesAnRelationUpdateEvents() : void
- getFormatFromPost() : string
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- secureData() : mixed
- sendEmail() : mixed
- validateDataLoader() : void
- writeUploadLog() : void
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()
Post create dataloader.
public
createAction() : string|false
request([ 'method' => 'POST', 'url' => '/api/v3/dataLoader/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'dataloader name' 'required' => true ], ] ]) response([ 'status' => '0', 'message' => DataLoaderEntity 'code' => 200 ])
Tags
Return values
string|false —deleteAction()
Post delete dataloader.
public
deleteAction() : string|false
request([ 'method' => 'POST', 'url' => '/api/v3/dataLoader/delete' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'dataloader id' 'required' => true ], ] ]) response([ 'status' => '0', 'message' => 'OK' 'code' => 200 ])
Tags
Return values
string|false —getAction()
Get data loaders.
public
getAction() : string|false
request([ 'method' => 'GET', 'url' => '/api/v3/dataLoader/get' ]) response([ 'status' => '0', 'message' => DataLoaderEntity[] 'code' => 200 ])
Return values
string|false —getUserFromPost()
public
getUserFromPost() : UserEntity|null
Tags
Return values
UserEntity|null —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —sendAction()
POST Action for send data to DataLoader param raw data $body Upload data param ObjectId $dataSetId DataSet id param string $updatePropertiesStrategy Update Properties Strategy may be "replace" or "merge"
public
sendAction() : string
Tags
Return values
string —200 OK
updateAction()
Post update dataloader.
public
updateAction() : string|false
request([ 'method' => 'POST', 'url' => '/api/v3/dataLoader/update' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'description' => 'dataloader name' 'required' => true ], ] ]) response([ 'status' => '0', 'message' => 'OK' 'code' => 200 ])
Tags
Return values
string|false —attachTmpFile()
protected
attachTmpFile(TmpFile $tmpFile) : Response
Parameters
- $tmpFile : TmpFile
Return values
Response —createObjectId()
protected
createObjectId(mixed $id, string $name) : ObjectId
Parameters
- $id : mixed
- $name : string
Tags
Return values
ObjectId —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 —getFormatFromPost()
protected
getFormatFromPost() : string
Tags
Return values
string —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
Return values
mixed —validateDataLoader()
protected
validateDataLoader(stdClass $data) : void
Parameters
- $data : stdClass
Return values
void —writeUploadLog()
private
writeUploadLog(string $message, int $code, array<string|int, mixed> $customer) : void
Parameters
- $message : string
- $code : int
- $customer : array<string|int, mixed>