SetaPDF_Core_Filter_Flate Class for handling zlib/deflate compression

File: /SetaPDF/Core/Filter/Flate.php

Class hierarchy

Implements

Summary

Properties

$_bitsPerComponent

$_colors

$_columns

$_predictor

$alwaysWritePredictorByte

If set to true, the algorithm byte is written at the beginning of every line for all PNG predictors.

If set to false, this byte is only written for optimum png compression, which can vary the compression algorithm for each row.


Methods

__construct()

public SetaPDF_Core_Filter_Predictor::__construct ( [ integer $predictor = null [, integer $colors = null [, integer $bitsPerComponent = null [, integer $columns = null ]]]] )

The constructor.

Parameters
$predictor : integer
 
$colors : integer
 
$bitsPerComponent : integer
 
$columns : integer
 

_paethPredictor()

protected int|float SetaPDF_Core_Filter_Predictor::_paethPredictor ( int|float $left, int|float $above, int|float $upperLeft )

Value prediction using the Alan W. Paeth algorithm.

Parameters
$left : int|float

The value to the left of the processed data entry.

$above : int|float

The value above the processed data entry.

$upperLeft : int|float

The value to the upper left of the processed data entry.

Return Values

Returns the prediction value according to the Peath algorithm

decode()

public string SetaPDF_Core_Filter_Flate::decode ( string $data )

Decodes a flate compressed string.

Parameters
$data : string

The input string

Exceptions

Throws SetaPDF_Core_Filter_Exception

encode()

public string SetaPDF_Core_Filter_Flate::encode ( string $data )

Encodes a string with flate compression.

Parameters
$data : string

The input string

Exceptions

Throws SetaPDF_Core_Filter_Exception