Home > PHP > Function > > HaruDoc::setCompressionMode()

HaruDoc::setCompressionMode()

HaruDoc::setCompressionMode - Set compression mode for the document

Syntax

bool HaruDoc::setCompressionMode (int $mode)

Arguments

  • mode - The compression mode to use. The value is a combination of the following flags: HaruDoc::COMP_NONE - all contents is not compressed. HaruDoc::COMP_TEXT - compress the text data. HaruDoc::COMP_IMAGE - compress the image data. HaruDoc::COMP_METADATA - compress other data (fonts, cmaps). HaruDoc::COMP_ALL - compress all data.

Description

Defines compression mode for the document. In case when libharu was compiled without Zlib support this function will always throw HaruException.

Version

PHP PECL haru >= 0.0.1

Return value

Returns TRUE on success.