API Documentation
\
DeviceAtlas
Carrier
DataFile
Device
CacheProvider
Exception

\DeviceAtlas\DataFileDataFileDecompressor

Decompresses a data file. Supports zip and gzip compression.

Summary

Methods
Properties
Constants
__construct()
getSupportedContentTypes()
isDecompressionRequired()
decompress()
No public properties found
XMSG_DECOMPRESS_ERROR
XMSG_DECOMPRESS_OPEN_FILE_ERROR
XMSG_ZIP_MOD_EXT_NOT_FOUND_ERROR
XMSG_ZLIB_MOD_EXT_NOT_FOUND_ERROR
CONTENT_TYPE_GZIP
CONTENT_TYPE_ZIP
No protected methods found
No protected properties found
N/A
decompressZip()
decompressGzip()
$supportedContentTypes
$dataFile
N/A

Constants

XMSG_DECOMPRESS_ERROR

XMSG_DECOMPRESS_ERROR = "Could not decompress gzipped/zipped content. Please check you have write permissions to: %s."

XMSG_DECOMPRESS_OPEN_FILE_ERROR

XMSG_DECOMPRESS_OPEN_FILE_ERROR = "Could not open gzipped/zipped content at: %s."

XMSG_ZIP_MOD_EXT_NOT_FOUND_ERROR

XMSG_ZIP_MOD_EXT_NOT_FOUND_ERROR = "Zip module/extension not found. Please install it or use gzip data file url for download."

XMSG_ZLIB_MOD_EXT_NOT_FOUND_ERROR

XMSG_ZLIB_MOD_EXT_NOT_FOUND_ERROR = "Zlib module/extension not found. Please install it or use zip data file url for download."

CONTENT_TYPE_GZIP

CONTENT_TYPE_GZIP = "application/x-gzip"

CONTENT_TYPE_ZIP

CONTENT_TYPE_ZIP = "application/zip"

Properties

$supportedContentTypes

$supportedContentTypes :

Type

$dataFile

$dataFile :

Type

Methods

__construct()

__construct(  $dataFile)

Parameters

$dataFile
Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

getSupportedContentTypes()

getSupportedContentTypes()

Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

isDecompressionRequired()

isDecompressionRequired(  $contentType)

Parameters

$contentType
Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Warning: count(): Parameter must be an array or an object that implements Countable in /opt/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275

decompress()

decompress(  $contentType) : boolean

Parameters

$contentType

Throws

\DeviceAtlas\Exception\DataLoadingException

Returns

boolean

decompressZip()

decompressZip() : boolean

Decompress Zip and extract in a 'configured_file_directory/temporary file'.

Delete the zip file.

Throws

\DeviceAtlas\Exception\DataLoadingException

Returns

boolean

decompressGzip()

decompressGzip() : boolean

Decompress Gzip and extract in a 'configured_file_directory/temporary file'.

Delete the gzip file.

Throws

\DeviceAtlas\Exception\DataLoadingException

Returns

boolean