AbstractExportHandler
in package
AbstractYes
Table of Contents
Constants
- ACTIVE_HANDLERS = [\Vatjar\Export\Component\TransactionVolumeExportHandler::class, \Vatjar\Export\Component\VatReportSummaryExportHandler::class, \Vatjar\Export\Component\MovementMissingCountryExportHandler::class, \Vatjar\Export\Component\StorageDetectionExportHandler::class, \Vatjar\Export\Component\TransactionToGbAfterBrexitExportHandler::class, \Vatjar\Export\Component\GermanYearlyFilingExportHandler::class, \Vatjar\Export\Component\ArrangedUserExportHandler::class, \Vatjar\Export\Component\YearlyTransactionCountExportHandler::class, \Vatjar\Export\Component\ItalianYearlyFilingExportHandler::class]
Properties
- $fileComponent : mixed
- $line : mixed
Methods
- createJob() : mixed
- filterParams() : array<string|int, mixed>
- getAllowedFilters() : array<string|int, mixed>
- getBucketName() : string
- getExportTypes() : array<string|int, mixed>
- getFileComponent() : AbstractExportFile
- getHeaders() : array<string|int, mixed>
- getLastRowsNumber() : array<string|int, mixed>
- getLine() : mixed
- Get the value of line
- getLines() : Generator<string|int, array<string|int, string>>
- getType() : string
- handle() : mixed
- markAsInProgress() : mixed
- validateParams() : void
- validatePositiveInteger() : mixed
- cloudPath() : mixed
- createFile() : resource
- filename() : string|null
- generateFile() : void
- getCloudStorageComponent() : mixed
- localPath() : mixed
- markAsDone() : mixed
- registerShutdownFunction() : mixed
- remoteUri() : mixed
- removeFile() : mixed
- saveError() : mixed
- saveToCloud() : mixed
- validateBool() : bool
- validateDate() : bool
- validateRequired() : bool
- validateString() : bool
Constants
ACTIVE_HANDLERS
public
mixed
ACTIVE_HANDLERS
= [\Vatjar\Export\Component\TransactionVolumeExportHandler::class, \Vatjar\Export\Component\VatReportSummaryExportHandler::class, \Vatjar\Export\Component\MovementMissingCountryExportHandler::class, \Vatjar\Export\Component\StorageDetectionExportHandler::class, \Vatjar\Export\Component\TransactionToGbAfterBrexitExportHandler::class, \Vatjar\Export\Component\GermanYearlyFilingExportHandler::class, \Vatjar\Export\Component\ArrangedUserExportHandler::class, \Vatjar\Export\Component\YearlyTransactionCountExportHandler::class, \Vatjar\Export\Component\ItalianYearlyFilingExportHandler::class]
Properties
$fileComponent
protected
mixed
$fileComponent
$line
private
mixed
$line
Methods
createJob()
public
final static createJob(Export $export) : mixed
Parameters
- $export : Export
Tags
filterParams()
public
abstract static filterParams(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>getAllowedFilters()
public
abstract getAllowedFilters() : array<string|int, mixed>
Return values
array<string|int, mixed>getBucketName()
public
getBucketName() : string
Return values
stringgetExportTypes()
public
static getExportTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>getFileComponent()
public
getFileComponent() : AbstractExportFile
Return values
AbstractExportFilegetHeaders()
public
abstract getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>getLastRowsNumber()
public
getLastRowsNumber() : array<string|int, mixed>
Return values
array<string|int, mixed>getLine()
Get the value of line
public
getLine() : mixed
getLines()
public
abstract getLines(array<string|int, mixed> $parameters) : Generator<string|int, array<string|int, string>>
Parameters
- $parameters : array<string|int, mixed>
Return values
Generator<string|int, array<string|int, string>>getType()
public
abstract static getType() : string
Return values
stringhandle()
public
final handle(Export &$export) : mixed
Parameters
- $export : Export
Tags
markAsInProgress()
public
markAsInProgress(Export &$export) : mixed
Parameters
- $export : Export
validateParams()
public
abstract static validateParams(array<string|int, mixed> $params) : void
Parameters
- $params : array<string|int, mixed>
validatePositiveInteger()
public
static validatePositiveInteger(mixed $value) : mixed
Parameters
- $value : mixed
cloudPath()
protected
cloudPath(Export $export) : mixed
Parameters
- $export : Export
createFile()
protected
createFile() : resource
Tags
Return values
resourcefilename()
protected
filename(Export $export) : string|null
Parameters
- $export : Export
Return values
string|nullgenerateFile()
protected
generateFile(resource $file, array<string|int, mixed> $parameters) : void
Parameters
- $file : resource
- $parameters : array<string|int, mixed>
Tags
getCloudStorageComponent()
protected
getCloudStorageComponent(string $bucket) : mixed
Parameters
- $bucket : string
localPath()
protected
localPath(resource $file) : mixed
Parameters
- $file : resource
markAsDone()
protected
markAsDone(resource $file, Export &$export) : mixed
Parameters
- $file : resource
- $export : Export
registerShutdownFunction()
protected
registerShutdownFunction(Export &$export, mixed &$file) : mixed
Parameters
- $export : Export
- $file : mixed
remoteUri()
protected
remoteUri(Export $export) : mixed
Parameters
- $export : Export
removeFile()
protected
removeFile(resource $file) : mixed
Parameters
- $file : resource
saveError()
protected
saveError(Export $export, Throwable $e) : mixed
Parameters
- $export : Export
- $e : Throwable
saveToCloud()
protected
saveToCloud(resource $file, Export $export) : mixed
Parameters
- $file : resource
- $export : Export
validateBool()
protected
static validateBool(mixed $value) : bool
Parameters
- $value : mixed
Return values
boolvalidateDate()
protected
static validateDate(mixed $value) : bool
Parameters
- $value : mixed
Return values
boolvalidateRequired()
protected
static validateRequired(mixed $value) : bool
Parameters
- $value : mixed
Return values
boolvalidateString()
protected
static validateString(mixed $value) : bool
Parameters
- $value : mixed