DatasetController
extends DatasetController
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 ] ] ]).
- deleteAttributeAction() : string
- POST Action for delete attributes from object require([ 'method' => 'POST', 'url' => '/api/v4/dataset/deleteAttribute' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'required' => true ], [ 'name' => 'attribute', 'type' => 'string', 'description' => 'attribute name', 'required' => true ] ] ])
- downloadAction() : string
- Download objects from many datasets request( 'method' => 'POST', 'url' => '/api/v4/dataset/download', 'params' => [ [ 'name' => 'query', 'type' => 'json', 'description' => 'Query to get objects', 'view' => { "format" : "gjr" | "osm" | "kml" | "kmz" | "dxf" | "gml" | "json" | "xls" | "gpx", "withRelatedObjects" : true | false, "downloadFilter" : "{{id}}=1&{{name}}="name"", "coordinates" : "52.65399891631596 82.79940605163576 52.65399891631596 82.57967948913576 52.71898249533673 82.57967948913576", "data" : [ { "dataSetId" : ObjectId, "objectsIds" : [ ObjectId, ObjectId ] }, { "dataSetId" : ObjectId, }, ... ] } 'require' => true ], [ 'name' => 'filename', 'type' => 'string', 'description' => 'Downloaded file name', 'require' => false ] ] ) response([ 'status' => 'OK', 'message' => DownloadedFileEntity 'code' => 0 ]).
- 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.
- getCommitsAction() : string
- Get incomplete commits require([ 'method' => 'GET', 'url' => '/api/v4/administration/dataset/getCommits' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'DataSet id', 'required' => false ] ] ])
- getDataSetsIndexesAction() : string
- Get datasets features indexes.
- getDataSetStatsAction() : string
- Get data set stats.
- getDependentDataSetsAction() : string
- Get master dataSet ids.
- getEditorObjectsAction() : string
- Get ways and nodes for editor by bbox Bbox [[lon, lat],[lon, lat]], first point is top left bound, second point bottom right bound request([ 'method' => 'GET'|'POST', 'url' => '/api/v4/dataSet/getEditorObjects' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'bbox', 'type' => 'json', 'required' => 'true' ], [ 'name' => 'polygon', 'type' => 'json', 'required' => 'true' ], [ 'name' => 'filter', 'type' => 'string', 'required' => 'false' ] ]).
- getEditorObjectsByRadiusAction() : bool|string
- Get relations with members by radius request([ 'method' => 'GET'|'POST', 'url' => '/api/v4/dataSet/getEditorObjectsByRadius' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'lat', 'type' => 'float', 'required' => 'true', 'description' => 'latitude center' ], [ 'name' => 'lon', 'type' => 'float', 'required' => 'true', 'description' => 'longitude center' ], [ 'name' => 'distance', 'type' => 'int', 'required' => 'true', 'description' => 'distance in meters' ], [ 'name' => 'filter', 'type' => 'string', 'required' => 'false' ] ]).
- getEditorObjectsByRelationsIdsAction() : bool|string
- Get relations with members by id request([ 'method' => 'GET'|'POST', 'url' => '/api/v4/dataSet/getEditorObjectsByRelationsIds' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'ids', 'type' => 'ObjectId[]', 'required' => 'true' ], [ 'name' => 'filter', 'type' => 'string', 'required' => 'false' ] ]).
- getEditorObjectsForRelationAction() : bool|string
- Get relations with members by id request([ 'method' => 'GET', 'url' => '/api/v4/dataSet/getEditorObjectsForRelation' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'id', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'uniqueValue', 'type' => 'string', 'required' => 'true' ] ]).
- getObjectsAction() : string
- request([ 'method' => 'GET', 'url' => '/api/v4/dataSet/getObjects' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'skip', 'type' => 'absint', 'required' => 'false', ], [ 'name' => 'limit', 'type' => 'absint', 'required' => 'false', ], [ 'name' => 'filterName', 'type' => 'string', 'required' => 'false', ], [ 'name' => 'filterValue', 'type' => 'json|string', 'required' => 'false', ] ]) response([ 'status' => 200, 'message' => Array<DataSetEntity>, 'code' => 0 ]).
- getRelatedObjectsAction() : string
- request([ 'method' => 'GET', 'url' => '/api/v4/dataSet/getRelatedObjects' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'relationId', 'type' => 'ObjectId', 'required' => 'true', ], [ 'name' => 'type', 'type' => 'string', 'required' => 'false', 'default' => 'full' ] ]) response([ 'status' => 200, 'message' => array, 'code' => 0 ]).
- 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' ] ] ]).
- getSnapshotsAction() : string
- Get snapshots files info.
- getUniqueValuesAction() : string
- GET Get unique values for field by properties request([ 'method' => 'GET', 'url' => '/api/v4/dataSet/getUniqueValues' 'params' => [ [ 'name' => 'dataSetsIds', 'type' => 'ObjectId[]', 'required' => 'true' ], [ 'name' => 'field', 'type' => 'string', 'required' => 'true' ], [ 'name' => 'value', 'type' => 'string', 'required' => 'false' ], [ 'name' => 'limit', 'type' => 'absint', 'required' => 'false', 'value' => 1000 ], [ 'name' => 'objectType', 'type' => 'string', 'required' => 'false', 'value' => Features ], [ 'name' => 'filter', 'type' => 'string' 'required' => false, 'value' => '', 'example' => '({{createDate}}>=1657731600&{{createDate}}<=1658422799)&({{status_rus}}="доставлено"|{{status_rus}}="отправлено")' ] ]).
- getWithAccessMaskAction() : string
- Get data sets with access mask.
- indexAction() : mixed
- initialize() : void
- isEditableAction() : string|false
- POST Action for check is editable object require([ 'method' => 'POST', 'url' => '/api/v4/dataset/isEditable' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'required' => true ], [ 'name' => 'objectIds', 'type' => 'ObjectId', 'description' => 'feature or relation id', 'required' => true ] ] ])
- rebuildAction() : string
- POST Action for rebuild dataSet objects require([ 'method' => 'POST', 'url' => '/api/v4/dataset/rebuild' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'required' => true ] ] ]).
- sendToGeocoderAction() : string
- Send object to geocoder.
- updateAction() : string
- POST Action for update DataSet require([ 'method' => 'POST', 'url' => '/api/v4/dataset/update' 'params' => [ [ 'name' => 'dataset', 'type' => 'json', 'description' => 'DataSetEntity', 'required' => true ] ] ]).
- 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 ] ] ]).
- validateAction() : string
- POST Action for validate dataSet objects require([ 'method' => 'POST', 'url' => '/api/v4/dataset/validate' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'required' => true ] ] ]).
- attachTmpFile() : Response
- firesAnRelationUpdateEvents() : void
- getDataSet() : DataSetEntity
- getId() : mixed
- getNormalizedUserId() : int|ObjectId
- getTranslator() : NativeArray
- getUserInfo() : UserEntity
- secureData() : mixed
- sendEmail() : mixed
- clearErrorsAndWarningsFromCommit() : array<string|int, mixed>
- getEditorObjectsByIds() : 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 —deleteAttributeAction()
POST Action for delete attributes from object require([ 'method' => 'POST', 'url' => '/api/v4/dataset/deleteAttribute' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'required' => true ], [ 'name' => 'attribute', 'type' => 'string', 'description' => 'attribute name', 'required' => true ] ] ])
public
deleteAttributeAction() : string
response([ 'status' => 'OK', 'code' => 0 ])
Tags
Return values
string —downloadAction()
Download objects from many datasets request( 'method' => 'POST', 'url' => '/api/v4/dataset/download', 'params' => [ [ 'name' => 'query', 'type' => 'json', 'description' => 'Query to get objects', 'view' => { "format" : "gjr" | "osm" | "kml" | "kmz" | "dxf" | "gml" | "json" | "xls" | "gpx", "withRelatedObjects" : true | false, "downloadFilter" : "{{id}}=1&{{name}}="name"", "coordinates" : "52.65399891631596 82.79940605163576 52.65399891631596 82.57967948913576 52.71898249533673 82.57967948913576", "data" : [ { "dataSetId" : ObjectId, "objectsIds" : [ ObjectId, ObjectId ] }, { "dataSetId" : ObjectId, }, ... ] } 'require' => true ], [ 'name' => 'filename', 'type' => 'string', 'description' => 'Downloaded file name', 'require' => false ] ] ) response([ 'status' => 'OK', 'message' => DownloadedFileEntity 'code' => 0 ]).
public
downloadAction() : string
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 —getCommitsAction()
Get incomplete commits require([ 'method' => 'GET', 'url' => '/api/v4/administration/dataset/getCommits' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'DataSet id', 'required' => false ] ] ])
public
getCommitsAction() : string
response([ 'status' => 200, 'message' => CommitEntity[], 'code' => 0 ])
Tags
Return values
string —getDataSetsIndexesAction()
Get datasets features indexes.
public
getDataSetsIndexesAction() : string
request([ 'method' => 'GET', 'url' => '/api/v4/dataset/getDataSetsIndexes', 'params' => [ [ 'name' => 'dataSetsIds', 'type' => 'ObjectId[]', 'required' => false ] ] ]) response([ 'status' => 200, 'message' => array, 'code' => 0 ]).
Return values
string —getDataSetStatsAction()
Get data set stats.
public
getDataSetStatsAction() : string
request([ 'method' => 'GET', 'url' => '/api/v4/dataset/getDataSetStats', 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => true 'description' => 'id of dataSet' ] ] ]) response([ 'status' => 200, 'message' => array, 'code' => 0 ]).
Tags
Return values
string —getDependentDataSetsAction()
Get master dataSet ids.
public
getDependentDataSetsAction() : string
request([ 'method' => 'GET', 'url' => '/api/v4/dataset/getDependentDataSets', 'params' => [ [ 'name' => 'dataSetsId', 'type' => 'ObjectId', 'required' => true 'description' => 'id of master dataSet' ] ] ]) response([ 'status' => 200, 'message' => DataSetEntity[], 'code' => 0 ]).
Tags
Return values
string —getEditorObjectsAction()
Get ways and nodes for editor by bbox Bbox [[lon, lat],[lon, lat]], first point is top left bound, second point bottom right bound request([ 'method' => 'GET'|'POST', 'url' => '/api/v4/dataSet/getEditorObjects' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'bbox', 'type' => 'json', 'required' => 'true' ], [ 'name' => 'polygon', 'type' => 'json', 'required' => 'true' ], [ 'name' => 'filter', 'type' => 'string', 'required' => 'false' ] ]).
public
getEditorObjectsAction() : string
Tags
Return values
string —getEditorObjectsByRadiusAction()
Get relations with members by radius request([ 'method' => 'GET'|'POST', 'url' => '/api/v4/dataSet/getEditorObjectsByRadius' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'lat', 'type' => 'float', 'required' => 'true', 'description' => 'latitude center' ], [ 'name' => 'lon', 'type' => 'float', 'required' => 'true', 'description' => 'longitude center' ], [ 'name' => 'distance', 'type' => 'int', 'required' => 'true', 'description' => 'distance in meters' ], [ 'name' => 'filter', 'type' => 'string', 'required' => 'false' ] ]).
public
getEditorObjectsByRadiusAction() : bool|string
Tags
Return values
bool|string —getEditorObjectsByRelationsIdsAction()
Get relations with members by id request([ 'method' => 'GET'|'POST', 'url' => '/api/v4/dataSet/getEditorObjectsByRelationsIds' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'ids', 'type' => 'ObjectId[]', 'required' => 'true' ], [ 'name' => 'filter', 'type' => 'string', 'required' => 'false' ] ]).
public
getEditorObjectsByRelationsIdsAction() : bool|string
Tags
Return values
bool|string —getEditorObjectsForRelationAction()
Get relations with members by id request([ 'method' => 'GET', 'url' => '/api/v4/dataSet/getEditorObjectsForRelation' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'id', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'uniqueValue', 'type' => 'string', 'required' => 'true' ] ]).
public
getEditorObjectsForRelationAction() : bool|string
Tags
Return values
bool|string —getObjectsAction()
request([ 'method' => 'GET', 'url' => '/api/v4/dataSet/getObjects' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'skip', 'type' => 'absint', 'required' => 'false', ], [ 'name' => 'limit', 'type' => 'absint', 'required' => 'false', ], [ 'name' => 'filterName', 'type' => 'string', 'required' => 'false', ], [ 'name' => 'filterValue', 'type' => 'json|string', 'required' => 'false', ] ]) response([ 'status' => 200, 'message' => Array<DataSetEntity>, 'code' => 0 ]).
public
getObjectsAction() : string
Tags
Return values
string —getRelatedObjectsAction()
request([ 'method' => 'GET', 'url' => '/api/v4/dataSet/getRelatedObjects' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => 'true' ], [ 'name' => 'relationId', 'type' => 'ObjectId', 'required' => 'true', ], [ 'name' => 'type', 'type' => 'string', 'required' => 'false', 'default' => 'full' ] ]) response([ 'status' => 200, 'message' => array, 'code' => 0 ]).
public
getRelatedObjectsAction() : 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 —getSnapshotsAction()
Get snapshots files info.
public
getSnapshotsAction() : string
request([ 'method' => 'GET', 'url' => '/api/v4/dataset/getSnapshots' 'params' => [] ]) response([ 'status' => 200, 'message' => array, 'code' => 0 ]).
Tags
Return values
string —getUniqueValuesAction()
GET Get unique values for field by properties request([ 'method' => 'GET', 'url' => '/api/v4/dataSet/getUniqueValues' 'params' => [ [ 'name' => 'dataSetsIds', 'type' => 'ObjectId[]', 'required' => 'true' ], [ 'name' => 'field', 'type' => 'string', 'required' => 'true' ], [ 'name' => 'value', 'type' => 'string', 'required' => 'false' ], [ 'name' => 'limit', 'type' => 'absint', 'required' => 'false', 'value' => 1000 ], [ 'name' => 'objectType', 'type' => 'string', 'required' => 'false', 'value' => Features ], [ 'name' => 'filter', 'type' => 'string' 'required' => false, 'value' => '', 'example' => '({{createDate}}>=1657731600&{{createDate}}<=1658422799)&({{status_rus}}="доставлено"|{{status_rus}}="отправлено")' ] ]).
public
getUniqueValuesAction() : string
Tags
Return values
string —getWithAccessMaskAction()
Get data sets with access mask.
public
getWithAccessMaskAction() : string
request([
'method' => 'GET',
'url' => '/api/v4/dataset/getWithAccessMask'
'params' => []
])
response([
'status' => 200,
'message' => Array
Return values
string —indexAction()
public
indexAction() : mixed
Return values
mixed —initialize()
public
initialize() : void
Return values
void —isEditableAction()
POST Action for check is editable object require([ 'method' => 'POST', 'url' => '/api/v4/dataset/isEditable' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'required' => true ], [ 'name' => 'objectIds', 'type' => 'ObjectId', 'description' => 'feature or relation id', 'required' => true ] ] ])
public
isEditableAction() : string|false
response([ 'status' => 'OK', 'message' => mapOfEditable 'code' => 0 ])
Tags
Return values
string|false —rebuildAction()
POST Action for rebuild dataSet objects require([ 'method' => 'POST', 'url' => '/api/v4/dataset/rebuild' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'required' => true ] ] ]).
public
rebuildAction() : string
response([ 'status' => 'OK', 'code' => 0 ])
Tags
Return values
string —sendToGeocoderAction()
Send object to geocoder.
public
sendToGeocoderAction() : string
request([ 'method' => 'POST', 'url' => '/api/v4/dataset/sendToGeocoder', 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'required' => true 'description' => 'id of dataSet' ], [ 'name' => 'filter', 'type' => 'string', 'required' => true 'description' => 'filter' ] ] ]) response([ 'status' => 200, 'message' => Ok, 'code' => 0 ]).
Tags
Return values
string —updateAction()
POST Action for update DataSet require([ 'method' => 'POST', 'url' => '/api/v4/dataset/update' 'params' => [ [ 'name' => 'dataset', 'type' => 'json', 'description' => 'DataSetEntity', 'required' => true ] ] ]).
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 —validateAction()
POST Action for validate dataSet objects require([ 'method' => 'POST', 'url' => '/api/v4/dataset/validate' 'params' => [ [ 'name' => 'dataSetId', 'type' => 'ObjectId', 'description' => 'dataSet id', 'required' => true ] ] ]).
public
validateAction() : string
response([ 'status' => 'OK', 'code' => 0 ])
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> —getEditorObjectsByIds()
private
getEditorObjectsByIds(array<string|int, mixed> $ids, RelatedDataSet $dataSet[, string $filter = '' ]) : array<string|int, mixed>
Parameters
- $ids : array<string|int, mixed>
- $dataSet : RelatedDataSet
- $filter : string = ''
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