DataFileManager
in package
Table of Contents
- XMSG_MALFORMED_URL = "Could not download data file due to a malformed URL: %s"
- XMSG_PERSIST_DATA_FILE = "Could not rename %s to %s. Please check you have write permissions."
- $dataFile : mixed
- $isNewFileAvailable : mixed
- __construct() : mixed
- downloadDataFile() : mixed
- Download data file
- getDataFile() : mixed
- getDownloadedDataFilePath() : string
- If the temporary data file exists on the system return the temporary file path.
- isNewFileAvailable() : mixed
- persistDataFile() : mixed
- The data file is downloaded into a temporary file. After the temporary file has been loaded by the API without exception this method will replace the existing data file with the temporary file.
Constants
XMSG_MALFORMED_URL
public
mixed
XMSG_MALFORMED_URL
= "Could not download data file due to a malformed URL: %s"
XMSG_PERSIST_DATA_FILE
public
mixed
XMSG_PERSIST_DATA_FILE
= "Could not rename %s to %s. Please check you have write permissions."
Properties
$dataFile
private
mixed
$dataFile
$isNewFileAvailable
private
mixed
$isNewFileAvailable
= \false
Methods
__construct()
public
__construct(mixed $dataFile) : mixed
Parameters
- $dataFile : mixed
Return values
mixed —downloadDataFile()
Download data file
public
downloadDataFile() : mixed
Tags
Return values
mixed —getDataFile()
public
getDataFile() : mixed
Return values
mixed —getDownloadedDataFilePath()
If the temporary data file exists on the system return the temporary file path.
public
getDownloadedDataFilePath() : string
If the data file exists return the file path. If the data file does not exist download it and return the temporary path the data file was saved to.
Tags
Return values
string —isNewFileAvailable()
public
isNewFileAvailable() : mixed
Return values
mixed —persistDataFile()
The data file is downloaded into a temporary file. After the temporary file has been loaded by the API without exception this method will replace the existing data file with the temporary file.
public
persistDataFile() : mixed