TCPDF_FILTERS
in package
Tags
Table of Contents
Methods
- decodeFilter() : string
- Decode data using the specified filter type.
- decodeFilterASCII85Decode() : string
- ASCII85Decode Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data.
- decodeFilterASCIIHexDecode() : string
- ASCIIHexDecode Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data.
- decodeFilterCCITTFaxDecode() : string
- CCITTFaxDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the CCITT facsimile standard, reproducing the original data (typically monochrome image data at 1 bit per pixel).
- decodeFilterCrypt() : string
- Crypt (NOT IMPLEMETED - RETURN AN EXCEPTION) Decrypts data encrypted by a security handler, reproducing the data as it was before encryption.
- decodeFilterDCTDecode() : string
- DCTDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using a DCT (discrete cosine transform) technique based on the JPEG standard, reproducing image sample data that approximates the original data.
- decodeFilterFlateDecode() : string
- FlateDecode Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data.
- decodeFilterJBIG2Decode() : string
- JBIG2Decode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the JBIG2 standard, reproducing the original monochrome (1 bit per pixel) image data (or an approximation of that data).
- decodeFilterJPXDecode() : string
- JPXDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data.
- decodeFilterLZWDecode() : string
- LZWDecode Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.
- decodeFilterRunLengthDecode() : mixed
- RunLengthDecode Decompresses data encoded using a byte-oriented run-length encoding algorithm.
- decodeFilterStandard() : string
- Standard Default decoding filter (leaves data unchanged).
- Error() : mixed
- Throw an exception.
- getAvailableFilters() : array<string|int, mixed>
- Get a list of available decoding filters.
Methods
decodeFilter()
Decode data using the specified filter type.
public static decodeFilter(string $filter,
string $data)
: string
Parameters
- $filter : string
-
Filter name.
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterASCII85Decode()
ASCII85Decode Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data.
public static decodeFilterASCII85Decode(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterASCIIHexDecode()
ASCIIHexDecode Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data.
public static decodeFilterASCIIHexDecode(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterCCITTFaxDecode()
CCITTFaxDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the CCITT facsimile standard, reproducing the original data (typically monochrome image data at 1 bit per pixel).
public static decodeFilterCCITTFaxDecode(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterCrypt()
Crypt (NOT IMPLEMETED - RETURN AN EXCEPTION) Decrypts data encrypted by a security handler, reproducing the data as it was before encryption.
public static decodeFilterCrypt(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterDCTDecode()
DCTDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using a DCT (discrete cosine transform) technique based on the JPEG standard, reproducing image sample data that approximates the original data.
public static decodeFilterDCTDecode(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterFlateDecode()
FlateDecode Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data.
public static decodeFilterFlateDecode(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterJBIG2Decode()
JBIG2Decode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the JBIG2 standard, reproducing the original monochrome (1 bit per pixel) image data (or an approximation of that data).
public static decodeFilterJBIG2Decode(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterJPXDecode()
JPXDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data.
public static decodeFilterJPXDecode(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterLZWDecode()
LZWDecode Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.
public static decodeFilterLZWDecode(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
decodeFilterRunLengthDecode()
RunLengthDecode Decompresses data encoded using a byte-oriented run-length encoding algorithm.
public static decodeFilterRunLengthDecode(string $data)
: mixed
Parameters
- $data : string
-
Data to decode.
Tags
decodeFilterStandard()
Standard Default decoding filter (leaves data unchanged).
public static decodeFilterStandard(string $data)
: string
Parameters
- $data : string
-
Data to decode.
Tags
Return values
string —Decoded data string.
Error()
Throw an exception.
public static Error(string $msg)
: mixed
Parameters
- $msg : string
-
The error message
Tags
getAvailableFilters()
Get a list of available decoding filters.
public static getAvailableFilters()
: array<string|int,
mixed>
Tags
Return values
array<string|int, mixed> —Array of available filter decoders.