class TCPDF_FILTERS (View source)

Methods

static array
getAvailableFilters()

Get a list of available decoding filters.

static string
decodeFilter(string $filter, string $data)

Decode data using the specified filter type.

static string
decodeFilterStandard(string $data)

Standard Default decoding filter (leaves data unchanged).

static string
decodeFilterASCIIHexDecode(string $data)

ASCIIHexDecode Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data.

static string
decodeFilterASCII85Decode(string $data)

ASCII85Decode Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data.

static string
decodeFilterLZWDecode(string $data)

LZWDecode Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.

static string
decodeFilterFlateDecode(string $data)

FlateDecode Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data.

static 
decodeFilterRunLengthDecode(string $data)

RunLengthDecode Decompresses data encoded using a byte-oriented run-length encoding algorithm.

static string
decodeFilterCCITTFaxDecode(string $data)

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).

static string
decodeFilterJBIG2Decode(string $data)

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).

static string
decodeFilterDCTDecode(string $data)

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.

static string
decodeFilterJPXDecode(string $data)

JPXDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data.

static string
decodeFilterCrypt(string $data)

Crypt (NOT IMPLEMETED - RETURN AN EXCEPTION) Decrypts data encrypted by a security handler, reproducing the data as it was before encryption.

static 
Error(string $msg)

Throw an exception.

Details

static array getAvailableFilters()

Since: 1.0.000 (2011-05-23)

Get a list of available decoding filters.

Return Value

array

Array of available filter decoders.

static string decodeFilter(string $filter, string $data)

Since: 1.0.000 (2011-05-23)

Decode data using the specified filter type.

Parameters

string $filter

Filter name.

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterStandard(string $data)

Since: 1.0.000 (2011-05-23)

Standard Default decoding filter (leaves data unchanged).

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterASCIIHexDecode(string $data)

Since: 1.0.000 (2011-05-23)

ASCIIHexDecode Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data.

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterASCII85Decode(string $data)

Since: 1.0.000 (2011-05-23)

ASCII85Decode Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data.

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterLZWDecode(string $data)

Since: 1.0.000 (2011-05-23)

LZWDecode Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterFlateDecode(string $data)

Since: 1.0.000 (2011-05-23)

FlateDecode Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data.

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static decodeFilterRunLengthDecode(string $data)

Since: 1.0.000 (2011-05-23)

RunLengthDecode Decompresses data encoded using a byte-oriented run-length encoding algorithm.

Parameters

string $data

Data to decode.

static string decodeFilterCCITTFaxDecode(string $data)

Since: 1.0.000 (2011-05-23)

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).

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterJBIG2Decode(string $data)

Since: 1.0.000 (2011-05-23)

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).

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterDCTDecode(string $data)

Since: 1.0.000 (2011-05-23)

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.

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterJPXDecode(string $data)

Since: 1.0.000 (2011-05-23)

JPXDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data.

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static string decodeFilterCrypt(string $data)

Since: 1.0.000 (2011-05-23)

Crypt (NOT IMPLEMETED - RETURN AN EXCEPTION) Decrypts data encrypted by a security handler, reproducing the data as it was before encryption.

Parameters

string $data

Data to decode.

Return Value

string

Decoded data string.

static Error(string $msg)

Since: 1.0.000 (2011-05-23)

Throw an exception.

Parameters

string $msg

The error message