BaseDeviceAtlasApi
in package
implements
DeviceAtlasApi
Interfaces, Classes and Traits
Table of Contents
- buildDataFile() : mixed
- downloadAndLoadDataFileFromUrl() : mixed
- Load the DeviceAtlas data file data from a URL.
- loadDataFromFile() : mixed
- reload() : mixed
- Downloads a new data file if the existing one is stale.
- scheduleReloadAndFinishRequest() : mixed
- A secondary register_shutdown_call to make sure the reload method is called as the last one.
- callFailureCallback() : mixed
- Call user defined callback if set.
- checkReloadSchedule() : mixed
Methods
buildDataFile()
public
abstract buildDataFile(mixed $dataFileDownloadUrl) : mixed
Parameters
- $dataFileDownloadUrl : mixed
Return values
mixed —downloadAndLoadDataFileFromUrl()
Load the DeviceAtlas data file data from a URL.
public
downloadAndLoadDataFileFromUrl(mixed $dataFile[, mixed $dataFileManager = null ]) : mixed
Schedule a reload if data file is stale. Re-download data file if local data file is corrupted.
Parameters
- $dataFile : mixed
- $dataFileManager : mixed = null
Tags
Return values
mixed —loadDataFromFile()
public
abstract loadDataFromFile(mixed $jsonDataFilePath) : mixed
Parameters
- $jsonDataFilePath : mixed
Return values
mixed —reload()
Downloads a new data file if the existing one is stale.
public
reload( $dataFile, $dataFileManager) : mixed
Loads data file into API.
Parameters
Return values
mixed —scheduleReloadAndFinishRequest()
A secondary register_shutdown_call to make sure the reload method is called as the last one.
public
scheduleReloadAndFinishRequest( $dataFile, $dataFileManager) : mixed
Parameters
Return values
mixed —callFailureCallback()
Call user defined callback if set.
private
callFailureCallback(Exception $ex, $dataFile) : mixed
Parameters
Return values
mixed —checkReloadSchedule()
private
checkReloadSchedule(mixed $dataFile, mixed $dataFileManager[, mixed $forceReload = false ]) : mixed
Parameters
- $dataFile : mixed
- $dataFileManager : mixed
- $forceReload : mixed = false