TCPDF_FILTERS Class Reference

This is a PHP class for decoding common PDF filters (PDF 32000-2008 - 7.4 Filters). More...

Static Public Member Functions
static	decodeFilter ($filter, $data)
	Decode data using the specified filter type.
static	decodeFilterASCII85Decode ($data)
	ASCII85Decode Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data.
static	decodeFilterASCIIHexDecode ($data)
	ASCIIHexDecode Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data.
static	decodeFilterCCITTFaxDecode ($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	decodeFilterCrypt ($data)
	Crypt (NOT IMPLEMETED - RETURN AN EXCEPTION) Decrypts data encrypted by a security handler, reproducing the data as it was before encryption.
static	decodeFilterDCTDecode ($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	decodeFilterFlateDecode ($data)
	FlateDecode Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data.
static	decodeFilterJBIG2Decode ($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	decodeFilterJPXDecode ($data)
	JPXDecode (NOT IMPLEMETED - RETURN AN EXCEPTION) Decompresses data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data.
static	decodeFilterLZWDecode ($data)
	LZWDecode Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.
static	decodeFilterRunLengthDecode ($data)
	RunLengthDecode Decompresses data encoded using a byte-oriented run-length encoding algorithm.
static	decodeFilterStandard ($data)
	Standard Default decoding filter (leaves data unchanged).
static	Error ($msg)
	Throw an exception.
static	getAvailableFilters ()
	Get a list of available decoding filters.

Detailed Description

This is a PHP class for decoding common PDF filters (PDF 32000-2008 - 7.4 Filters).

..

This is a PHP class for decoding common PDF filters.

Version

1.0.001

Author

Nicola Asuni - info@.nosp@m.tecn.nosp@m.ick.c.nosp@m.om

Member Function Documentation

decodeFilter()

static TCPDF_FILTERS::decodeFilter ( $filter, $data )

static

Decode data using the specified filter type.

Parameters

string	$filter	Filter name.
string	$data	Data to decode.

Return values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterASCII85Decode()

static TCPDF_FILTERS::decodeFilterASCII85Decode ( $data )

static

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

Parameters

string

$data

Data to decode.

Return values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterASCIIHexDecode()

static TCPDF_FILTERS::decodeFilterASCIIHexDecode ( $data )

static

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

Parameters

string

$data

Data to decode.

Return values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterCCITTFaxDecode()

static TCPDF_FILTERS::decodeFilterCCITTFaxDecode ( $data )

static

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 values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterCrypt()

static TCPDF_FILTERS::decodeFilterCrypt ( $data )

static

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 values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterDCTDecode()

static TCPDF_FILTERS::decodeFilterDCTDecode ( $data )

static

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 values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterFlateDecode()

static TCPDF_FILTERS::decodeFilterFlateDecode ( $data )

static

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

Parameters

string

$data

Data to decode.

Return values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterJBIG2Decode()

static TCPDF_FILTERS::decodeFilterJBIG2Decode ( $data )

static

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 values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterJPXDecode()

static TCPDF_FILTERS::decodeFilterJPXDecode ( $data )

static

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 values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterLZWDecode()

static TCPDF_FILTERS::decodeFilterLZWDecode ( $data )

static

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 values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

decodeFilterRunLengthDecode()

static TCPDF_FILTERS::decodeFilterRunLengthDecode ( $data )

static

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

Parameters

string

$data

Data to decode.

Since

1.0.000 (2011-05-23) static

decodeFilterStandard()

static TCPDF_FILTERS::decodeFilterStandard ( $data )

static

Standard Default decoding filter (leaves data unchanged).

Parameters

string

$data

Data to decode.

Return values

string

Decoded data string.

Since

1.0.000 (2011-05-23) static

Error()

static TCPDF_FILTERS::Error ( $msg )

static

Throw an exception.

Parameters

string

$msg

The error message

Since

1.0.000 (2011-05-23) static

getAvailableFilters()

static TCPDF_FILTERS::getAvailableFilters ( )

static

Get a list of available decoding filters.

Return values

array

Array of available filter decoders.

Since

1.0.000 (2011-05-23) static

---

The documentation for this class was generated from the following file:

• lib/tcpdf/include/tcpdf_filters.php