DatasetController
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
- cancelUploadAction() : string
- Cancel upload.
- cleaningAction() : string
- POST Action for clean dataSet object request([ 'method' => 'POST', 'url' => '/api/v3/dataset/cleaning' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ]).
- createAction() : string
- POST Action for create DataSet request([ 'method' => 'POST', 'url' => '/api/v3/dataset/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'type', 'type' => 'string', 'required' => false ], [ 'name' => 'masterId', 'type' => 'objectId', 'required' => false ] ] ]).
- deleteAction() : string|false
- POST Action for delete DataSet request([ 'method' => 'POST', 'url' => '/api/v3/dataset/delete' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'DataSet id', 'required' => true ] ] ]).
- downloadAction() : string
- Action for download dataSet objects.
- editorAction() : bool|string
- request([ 'method' => 'GET', 'url' => '/api/v3/dataSet/editor' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'commit', 'type' => 'json', 'required' => 'true' ], [ 'name' => 'splitLine', 'type' => 'ObjectId', 'required' => 'false' ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ]).
- findAction() : string
- GET Action for find DataSet by name request([ 'method' => 'GET', 'url' => '/api/v3/dataset/find' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'id', 'type' => 'string', 'required' => false ] ] ]).
- findByIdsAction() : string
- getAction() : string
- Action for get DataSets.
- getAvailableAction() : string
- Action for get available DataSets by access mask.
- getReportAction() : void
- GET Get report by errors request([ 'method' => 'GET', 'url' => '/api/v4/dataset/getReport', 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => 'true' ], [ 'name' => 'language', 'type' => 'string', 'required' => 'false' ], [ 'name' => 'format', 'type' => 'string', 'required' => 'false' ], [ 'name' => 'limit', 'type' => 'int', 'required' => 'false' ], [ 'name' => 'type', 'type' => 'string', 'required' => 'false' ] ] ]).
- getUniqueValuesAction() : string
- GET Get unique values for field by properties request([ 'method' => 'GET', 'url' => '/api/v3/dataset/getUniqueValues' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'objectType', 'type' => 'Features' | 'Relations', 'required' => 'false', 'value' => 'Features ], [ 'name' => 'field', 'type' => 'string', 'required' => 'true' ], [ 'name' => 'value', 'type' => 'string', 'required' => 'false' ], [ 'name' => 'limit', 'type' => 'absint', 'required' => 'false', 'value' => 1000 ], ]) response ([ 'status' = 200, 'message' = array, 'code' = 0 ]).
- indexAction() : mixed
- initialize() : void
- updateAction() : string
- POST Action for update DataSet request([ 'method' => 'POST', 'url' => '/api/v3/dataset/update' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'name', 'type' => 'string' 'required' => false, ], [ 'name' => 'cluster', 'type' => 'json', 'required' => false, ], [ 'name' => 'uniqueField', 'type' => 'string', 'required' => false ], [ 'name' => 'lengthField', 'type' => 'string', 'required' => false ], [ 'name' => 'areaField', 'type' => 'string', 'required' => false ], [ 'name' => 'measure', 'type' => 'string', 'allowed_values' => ['kilometres', 'meters'], 'required' => false, but true if lengthField was set ] ] ]).
- uploadAction() : string
- Post Upload data to DataSet request([ 'method' => 'POST', 'url' => '/api/v3/dataset/upload' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'format', 'type' => 'string', 'required' => false ] ] ]).
- attachTmpFile() : Response
- firesAnRelationUpdateEvents() : void
- getDataSet() : DataSetEntity
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- secureData() : mixed
- sendEmail() : mixed
- clearErrorsAndWarningsFromCommit() : array<string|int, mixed>
- splitLine() : array<string|int, 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 —cancelUploadAction()
Cancel upload.
public
cancelUploadAction() : string
request([ 'method' => 'POST', 'url' => '/api/v3/dataset/cancelUpload' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'logId', 'type' => 'ObjectId', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => 'Ok', 'code' => 0 ]).
Tags
Return values
string —cleaningAction()
POST Action for clean dataSet object request([ 'method' => 'POST', 'url' => '/api/v3/dataset/cleaning' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ]).
public
cleaningAction() : string
Tags
Return values
string —createAction()
POST Action for create DataSet request([ 'method' => 'POST', 'url' => '/api/v3/dataset/create' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'type', 'type' => 'string', 'required' => false ], [ 'name' => 'masterId', 'type' => 'objectId', 'required' => false ] ] ]).
public
createAction() : string
response([ 'status' => 'OK', 'message' => DataSetEntity 'code' => 0 ])
Tags
Return values
string —deleteAction()
POST Action for delete DataSet request([ 'method' => 'POST', 'url' => '/api/v3/dataset/delete' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'DataSet id', 'required' => true ] ] ]).
public
deleteAction() : string|false
response([ 'status' => 'OK', 'code' => 0 ])
Tags
Return values
string|false —downloadAction()
Action for download dataSet objects.
public
downloadAction() : string
request([ 'method' => 'POST', 'url' => '/api/v3/dataset/download' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'format', 'type' => 'string', 'required' => false ], [ 'name' => 'filename', 'type' => 'string', 'required' => false ], [ 'name' => 'values', 'type' => 'json', 'required' => false ], [ 'name' => 'filter', 'type' => 'string', 'required' => false ], [ 'name' => 'coordinates', 'type' => 'string', 'required' => false ], [ 'name' => 'withRelatedObjects', 'type' => 'bool', 'required' => false ] ] ]) response([ 'status' => 'OK', 'message' => DownloadLogEntity 'code' => 0 ]).
Tags
Return values
string —editorAction()
request([ 'method' => 'GET', 'url' => '/api/v3/dataSet/editor' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'commit', 'type' => 'json', 'required' => 'true' ], [ 'name' => 'splitLine', 'type' => 'ObjectId', 'required' => 'false' ] ]) response ([ 'status' = 200, 'message' = 'OK', 'code' = 0 ]).
public
editorAction() : bool|string
Tags
Return values
bool|string —findAction()
GET Action for find DataSet by name request([ 'method' => 'GET', 'url' => '/api/v3/dataset/find' 'params' => [ [ 'name' => 'name', 'type' => 'string', 'required' => false ], [ 'name' => 'id', 'type' => 'string', 'required' => false ] ] ]).
public
findAction() : string
response([ 'status' => 'OK', 'message' => array, 'code' => 0 ])
Return values
string —findByIdsAction()
public
findByIdsAction() : string
Return values
string —getAction()
Action for get DataSets.
public
getAction() : string
Tags
Return values
string —getAvailableAction()
Action for get available DataSets by access mask.
public
getAvailableAction() : string
Tags
Return values
string —getReportAction()
GET Get report by errors request([ 'method' => 'GET', 'url' => '/api/v4/dataset/getReport', 'params' => [ [ 'name' => 'dataSetId', 'type' => 'objectId', 'required' => 'true' ], [ 'name' => 'language', 'type' => 'string', 'required' => 'false' ], [ 'name' => 'format', 'type' => 'string', 'required' => 'false' ], [ 'name' => 'limit', 'type' => 'int', 'required' => 'false' ], [ 'name' => 'type', 'type' => 'string', 'required' => 'false' ] ] ]).
public
getReportAction() : void
Tags
Return values
void —getUniqueValuesAction()
GET Get unique values for field by properties request([ 'method' => 'GET', 'url' => '/api/v3/dataset/getUniqueValues' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'objectType', 'type' => 'Features' | 'Relations', 'required' => 'false', 'value' => 'Features ], [ 'name' => 'field', 'type' => 'string', 'required' => 'true' ], [ 'name' => 'value', 'type' => 'string', 'required' => 'false' ], [ 'name' => 'limit', 'type' => 'absint', 'required' => 'false', 'value' => 1000 ], ]) response ([ 'status' = 200, 'message' = array, 'code' = 0 ]).
public
getUniqueValuesAction() : string
Tags
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —updateAction()
POST Action for update DataSet request([ 'method' => 'POST', 'url' => '/api/v3/dataset/update' 'params' => [ [ 'name' => 'id', 'type' => 'ObjectId', 'description' => 'DataSet id', 'required' => true ], [ 'name' => 'name', 'type' => 'string' 'required' => false, ], [ 'name' => 'cluster', 'type' => 'json', 'required' => false, ], [ 'name' => 'uniqueField', 'type' => 'string', 'required' => false ], [ 'name' => 'lengthField', 'type' => 'string', 'required' => false ], [ 'name' => 'areaField', 'type' => 'string', 'required' => false ], [ 'name' => 'measure', 'type' => 'string', 'allowed_values' => ['kilometres', 'meters'], 'required' => false, but true if lengthField was set ] ] ]).
public
updateAction() : string
response([ 'status' => 'OK', 'code' => 0 ])
Tags
Return values
string —uploadAction()
Post Upload data to DataSet request([ 'method' => 'POST', 'url' => '/api/v3/dataset/upload' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => true ], [ 'name' => 'format', 'type' => 'string', 'required' => false ] ] ]).
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 —getDataSet()
protected
getDataSet(ObjectId $dataSetId, int $accessMask, ObjectId $userId) : DataSetEntity
Parameters
- $dataSetId : ObjectId
- $accessMask : int
- $userId : ObjectId
Return values
DataSetEntity —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 —clearErrorsAndWarningsFromCommit()
private
clearErrorsAndWarningsFromCommit(array<string|int, mixed> $commit) : array<string|int, mixed>
Parameters
- $commit : array<string|int, mixed>
Return values
array<string|int, mixed> —splitLine()
private
splitLine(array<string|int, mixed> $commit, ObjectId $pointCategoryId) : array<string|int, mixed>
Parameters
- $commit : array<string|int, mixed>
- $pointCategoryId : ObjectId