FilterHelper
in package
Table of Contents
Properties
- $availableFilters : mixed
Methods
- decodeFilter() : string
- Decode data using the specified filter type.
- getAvailableFilters() : array<string|int, mixed>
- decodeFilterASCII85Decode() : string
- ASCII85Decode
- decodeFilterASCIIHexDecode() : string
- ASCIIHexDecode
- decodeFilterFlateDecode() : string
- FlateDecode
- decodeFilterLZWDecode() : string
- LZWDecode
- decodeFilterRunLengthDecode() : string
- RunLengthDecode
Properties
$availableFilters
protected
mixed
$availableFilters
= ['ASCIIHexDecode', 'ASCII85Decode', 'LZWDecode', 'FlateDecode', 'RunLengthDecode']
Methods
decodeFilter()
Decode data using the specified filter type.
public
decodeFilter(string $filter, string $data[, int $decodeMemoryLimit = 0 ]) : string
Parameters
- $filter : string
-
Filter name
- $data : string
-
Data to decode
- $decodeMemoryLimit : int = 0
Tags
Return values
string —Decoded data string
getAvailableFilters()
public
getAvailableFilters() : array<string|int, mixed>
Return values
array<string|int, mixed> —list of available filters
decodeFilterASCII85Decode()
ASCII85Decode
protected
decodeFilterASCII85Decode(string $data) : string
Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data.
Parameters
- $data : string
-
Data to decode
Tags
Return values
string —data string
decodeFilterASCIIHexDecode()
ASCIIHexDecode
protected
decodeFilterASCIIHexDecode(string $data) : string
Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data.
Parameters
- $data : string
-
Data to decode
Tags
Return values
string —data string
decodeFilterFlateDecode()
FlateDecode
protected
decodeFilterFlateDecode(string $data, int $decodeMemoryLimit) : string
Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data.
Parameters
- $data : string
-
Data to decode
- $decodeMemoryLimit : int
-
Memory limit on deflation
Tags
Return values
string —data string
decodeFilterLZWDecode()
LZWDecode
protected
decodeFilterLZWDecode(string $data) : string
Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.
Parameters
- $data : string
-
Data to decode
Return values
string —Data string
decodeFilterRunLengthDecode()
RunLengthDecode
protected
decodeFilterRunLengthDecode(string $data) : string
Decompresses data encoded using a byte-oriented run-length encoding algorithm.
Parameters
- $data : string
-
Data to decode