Documentation

DataFile
in package

Table of Contents

MILLISECONDS_IN_A_DAY  = 24 * 60 * 60 * 1000
PATH_SEPARATOR  = "/"
$dataMetaFile  : mixed
$disableScheduledDownloadAndReload  : mixed
$downloadAndLoadFrequencyDays  : mixed
$downloadAndLoadTaskFailureCallback  : mixed
$downloadReadTimeoutMilliseconds  : mixed
$downloadUrl  : mixed
$fileDirectory  : mixed
$fileExtension  : mixed
$fileName  : mixed
$headerContentMd5  : mixed
$supportedContentTypes  : mixed
$temporaryFileName  : mixed
$validateMd5  : mixed
__construct()  : mixed
Builder()  : mixed
createTemporaryFileName()  : mixed
exists()  : mixed
getDataMetaFile()  : mixed
getDownloadAndLoadFrequencyDays()  : mixed
getDownloadAndLoadFrequencyMilliseconds()  : mixed
getDownloadAndLoadTaskFailureCallback()  : mixed
getDownloadReadTimeoutMilliseconds()  : mixed
getDownloadUrl()  : mixed
getFileDirectory()  : mixed
getFileExtension()  : mixed
getFileName()  : mixed
getFilePath()  : mixed
getHeaderContentMd5()  : mixed
getLockFilePath()  : mixed
getSupportedContentTypes()  : mixed
getTemporaryDownloadFilePath()  : mixed
getTemporaryFileName()  : mixed
getTemporaryFilePath()  : mixed
isContentTypeSupported()  : mixed
isDataFileReloadIsInProgress()  : mixed
isDisableScheduledDownloadAndReload()  : mixed
isStale()  : mixed
isValidateMd5()  : mixed
temporaryFileExists()  : mixed
createFilePath()  : mixed
validate()  : mixed
validateArgumentNotEmptyOrNull()  : mixed
validateIntIsPositive()  : mixed

Constants

MILLISECONDS_IN_A_DAY

public mixed MILLISECONDS_IN_A_DAY = 24 * 60 * 60 * 1000

PATH_SEPARATOR

public mixed PATH_SEPARATOR = "/"

Properties

$dataMetaFile

private mixed $dataMetaFile

$disableScheduledDownloadAndReload

private mixed $disableScheduledDownloadAndReload

$downloadAndLoadFrequencyDays

private mixed $downloadAndLoadFrequencyDays

$downloadAndLoadTaskFailureCallback

private mixed $downloadAndLoadTaskFailureCallback

$downloadReadTimeoutMilliseconds

private mixed $downloadReadTimeoutMilliseconds

$fileDirectory

private mixed $fileDirectory

$fileExtension

private mixed $fileExtension

$headerContentMd5

private mixed $headerContentMd5

$supportedContentTypes

private mixed $supportedContentTypes

$temporaryFileName

private mixed $temporaryFileName

Methods

Builder()

public static Builder(mixed $downloadUrl) : mixed
Parameters
$downloadUrl : mixed
Return values
mixed —

createTemporaryFileName()

public static createTemporaryFileName() : mixed
Return values
mixed —

exists()

public exists() : mixed
Return values
mixed —

getDataMetaFile()

public getDataMetaFile() : mixed
Return values
mixed —

getDownloadAndLoadFrequencyDays()

public getDownloadAndLoadFrequencyDays() : mixed
Return values
mixed —

getDownloadAndLoadFrequencyMilliseconds()

public getDownloadAndLoadFrequencyMilliseconds() : mixed
Return values
mixed —

getDownloadAndLoadTaskFailureCallback()

public getDownloadAndLoadTaskFailureCallback() : mixed
Return values
mixed —

getDownloadReadTimeoutMilliseconds()

public getDownloadReadTimeoutMilliseconds() : mixed
Return values
mixed —

getDownloadUrl()

public getDownloadUrl() : mixed
Return values
mixed —

getFileDirectory()

public getFileDirectory() : mixed
Return values
mixed —

getFileExtension()

public getFileExtension() : mixed
Return values
mixed —

getFileName()

public getFileName() : mixed
Return values
mixed —

getFilePath()

public getFilePath() : mixed
Return values
mixed —

getHeaderContentMd5()

public getHeaderContentMd5() : mixed
Return values
mixed —

getLockFilePath()

public getLockFilePath() : mixed
Return values
mixed —

getSupportedContentTypes()

public getSupportedContentTypes() : mixed
Return values
mixed —

getTemporaryDownloadFilePath()

public getTemporaryDownloadFilePath() : mixed
Return values
mixed —

getTemporaryFileName()

public getTemporaryFileName() : mixed
Return values
mixed —

getTemporaryFilePath()

public getTemporaryFilePath() : mixed
Return values
mixed —

isContentTypeSupported()

public isContentTypeSupported(mixed $contentType) : mixed
Parameters
$contentType : mixed
Return values
mixed —

isDataFileReloadIsInProgress()

public isDataFileReloadIsInProgress() : mixed
Return values
mixed —

isDisableScheduledDownloadAndReload()

public isDisableScheduledDownloadAndReload() : mixed
Return values
mixed —

isStale()

public isStale() : mixed
Return values
mixed —

isValidateMd5()

public isValidateMd5() : mixed
Return values
mixed —

temporaryFileExists()

public temporaryFileExists() : mixed
Return values
mixed —

createFilePath()

private createFilePath(mixed $dataFileName) : mixed
Parameters
$dataFileName : mixed
Return values
mixed —

validate()

private validate() : mixed
Return values
mixed —

validateArgumentNotEmptyOrNull()

private validateArgumentNotEmptyOrNull(mixed $argumentName, mixed $argumentValue) : mixed
Parameters
$argumentName : mixed
$argumentValue : mixed
Return values
mixed —

validateIntIsPositive()

private validateIntIsPositive(mixed $argumentName, mixed $argumentValue) : mixed
Parameters
$argumentName : mixed
$argumentValue : mixed
Return values
mixed —

Search results