DownloadObjectsTask
extends AirlayTask
in package
airlay-cli download_objects
Table of Contents
- MAX_FILES_COUNT = 600
- mainAction() : void
- processBody() : void
- abortWorkWithMessage() : never
- addFilesToZip() : TmpArchive
- convertFeatures() : array<string|int, mixed>
- createExportWorker() : ExportWorker
- createFile() : TmpFile
- getDataSetTitle() : string
- parseFlagsFromParams() : void
- Parse command line arguments from array. Output default values if --help or -h argument specified.
- processMessage() : void
- requestConfirm() : bool
- save() : array<string|int, mixed>
- createDownloadFilter() : array<string|int, mixed>
- download() : array<string|int, mixed>
- exportChunk() : Generator
- generateFile() : string
- getValuesIds() : array<string|int, mixed>
- parseObjectId() : ObjectId
- setStatus() : void
- stringToCoordinates() : array<string|int, mixed>
Constants
MAX_FILES_COUNT
private
mixed
MAX_FILES_COUNT
= 600
Methods
mainAction()
public
mainAction() : void
Tags
Return values
void —processBody()
public
processBody(DownloadFileBody $body) : void
Parameters
- $body : DownloadFileBody
Return values
void —abortWorkWithMessage()
protected
abortWorkWithMessage(string $message) : never
Parameters
- $message : string
Return values
never —addFilesToZip()
protected
addFilesToZip(array<string|int, mixed> $files, string $format, string $filename) : TmpArchive
Parameters
- $files : array<string|int, mixed>
- $format : string
- $filename : string
Return values
TmpArchive —convertFeatures()
protected
convertFeatures(DataSetEntity $dataSet, array<string|int, mixed> $features, string $format) : array<string|int, mixed>
Parameters
- $dataSet : DataSetEntity
- $features : array<string|int, mixed>
- $format : string
Return values
array<string|int, mixed> —createExportWorker()
protected
createExportWorker(DataSetEntity $dataSet, ObjectId $userId, bool $withRelatedObjects, array<string|int, mixed>|null $values, string|null $downloadFilter, string|null $coordinates, string $format) : ExportWorker
Parameters
- $dataSet : DataSetEntity
- $userId : ObjectId
- $withRelatedObjects : bool
- $values : array<string|int, mixed>|null
- $downloadFilter : string|null
- $coordinates : string|null
- $format : string
Return values
ExportWorker —createFile()
protected
createFile(array<string|int, mixed> $objects, string $format, DataSetEntity $dataSet) : TmpFile
Parameters
- $objects : array<string|int, mixed>
- $format : string
- $dataSet : DataSetEntity
Tags
Return values
TmpFile —getDataSetTitle()
protected
getDataSetTitle(array<string|int, mixed>|DataSetEntity $dataSet) : string
Parameters
- $dataSet : array<string|int, mixed>|DataSetEntity
Return values
string —parseFlagsFromParams()
Parse command line arguments from array. Output default values if --help or -h argument specified.
protected
parseFlagsFromParams(Flags $flags[, array<string|int, mixed> $params = [] ]) : void
Parameters
- $flags : Flags
- $params : array<string|int, mixed> = []
Return values
void —processMessage()
protected
processMessage(AMQPMessage $message, DownloadFileBody $body) : void
Parameters
- $message : AMQPMessage
- $body : DownloadFileBody
Return values
void —requestConfirm()
protected
requestConfirm(string $message) : bool
Parameters
- $message : string
Return values
bool —save()
protected
save(array<string|int, mixed> $files, string $format, string $filename) : array<string|int, mixed>
Parameters
- $files : array<string|int, mixed>
- $format : string
- $filename : string
Return values
array<string|int, mixed> —createDownloadFilter()
private
createDownloadFilter(array<string|int, mixed>|null $userFilters, array<string|int, mixed>|null $values, string|null $downloadFilter) : array<string|int, mixed>
Parameters
- $userFilters : array<string|int, mixed>|null
- $values : array<string|int, mixed>|null
- $downloadFilter : string|null
Return values
array<string|int, mixed> —download()
private
download(DownloadFileBody $body) : array<string|int, mixed>
Parameters
- $body : DownloadFileBody
Return values
array<string|int, mixed> —exportChunk()
private
exportChunk(ExportWorker $exportWorker) : Generator
Parameters
- $exportWorker : ExportWorker
Return values
Generator —generateFile()
private
generateFile(array<string|int, mixed> $objects, string $format, string|null $dataSetUniqueField) : string
Parameters
- $objects : array<string|int, mixed>
- $format : string
- $dataSetUniqueField : string|null
Return values
string —getValuesIds()
private
getValuesIds(array<string|int, mixed> $values) : array<string|int, mixed>
Parameters
- $values : array<string|int, mixed>
Return values
array<string|int, mixed> —parseObjectId()
private
parseObjectId(string $id) : ObjectId
Parameters
- $id : string
Return values
ObjectId —setStatus()
private
setStatus(DownloadedFileEntity $downloadLog, string $status) : void
Parameters
- $downloadLog : DownloadedFileEntity
- $status : string
Return values
void —stringToCoordinates()
private
stringToCoordinates(string $coordinatesString) : array<string|int, mixed>
Parameters
- $coordinatesString : string