Documentation

Config
in package

This class contains configurations used in various classes. You can override them manually, in case default values aren't working.

Tags
see
https://github.com/smalot/pdfparser/issues/305

Table of Contents

Properties

$dataTmFontInfoHasToBeIncluded  : bool
Whether to include font id and size in dataTm array
$decodeMemoryLimit  : int
Memory limit to use when de-compressing files, in bytes.
$fontSpaceLimit  : mixed
$horizontalOffset  : string
$ignoreEncryption  : bool
Whether to attempt to read PDFs even if they are marked as encrypted.
$pdfWhitespaces  : string
Represents: (NUL, HT, LF, FF, CR, SP)
$pdfWhitespacesRegex  : string
Represents: (NUL, HT, LF, FF, CR, SP)
$retainImageContent  : bool
Whether to retain raw image data as content or discard it to save memory

Methods

getDataTmFontInfoHasToBeIncluded()  : bool
getDecodeMemoryLimit()  : int
getFontSpaceLimit()  : mixed
getHorizontalOffset()  : string
getIgnoreEncryption()  : bool
getPdfWhitespaces()  : string
getPdfWhitespacesRegex()  : string
getRetainImageContent()  : bool
setDataTmFontInfoHasToBeIncluded()  : void
setDecodeMemoryLimit()  : void
setFontSpaceLimit()  : mixed
setHorizontalOffset()  : void
setIgnoreEncryption()  : void
setPdfWhitespaces()  : void
setPdfWhitespacesRegex()  : void
setRetainImageContent()  : void

Properties

$dataTmFontInfoHasToBeIncluded

Whether to include font id and size in dataTm array

private bool $dataTmFontInfoHasToBeIncluded = false

$decodeMemoryLimit

Memory limit to use when de-compressing files, in bytes.

private int $decodeMemoryLimit = 0

$fontSpaceLimit

private mixed $fontSpaceLimit = -50

$horizontalOffset

private string $horizontalOffset = ' '

$ignoreEncryption

Whether to attempt to read PDFs even if they are marked as encrypted.

private bool $ignoreEncryption = false

$pdfWhitespaces

Represents: (NUL, HT, LF, FF, CR, SP)

private string $pdfWhitespaces = "\x00\t\n\f\r "

$pdfWhitespacesRegex

Represents: (NUL, HT, LF, FF, CR, SP)

private string $pdfWhitespacesRegex = '[\0\t\n\f\r ]'

$retainImageContent

Whether to retain raw image data as content or discard it to save memory

private bool $retainImageContent = true

Methods

getDataTmFontInfoHasToBeIncluded()

public getDataTmFontInfoHasToBeIncluded() : bool
Return values
bool

getDecodeMemoryLimit()

public getDecodeMemoryLimit() : int
Return values
int

getFontSpaceLimit()

public getFontSpaceLimit() : mixed

getHorizontalOffset()

public getHorizontalOffset() : string
Return values
string

getIgnoreEncryption()

public getIgnoreEncryption() : bool
Return values
bool

getPdfWhitespaces()

public getPdfWhitespaces() : string
Return values
string

getPdfWhitespacesRegex()

public getPdfWhitespacesRegex() : string
Return values
string

getRetainImageContent()

public getRetainImageContent() : bool
Return values
bool

setDataTmFontInfoHasToBeIncluded()

public setDataTmFontInfoHasToBeIncluded(bool $dataTmFontInfoHasToBeIncluded) : void
Parameters
$dataTmFontInfoHasToBeIncluded : bool

setDecodeMemoryLimit()

public setDecodeMemoryLimit(int $decodeMemoryLimit) : void
Parameters
$decodeMemoryLimit : int

setFontSpaceLimit()

public setFontSpaceLimit(mixed $value) : mixed
Parameters
$value : mixed

setHorizontalOffset()

public setHorizontalOffset(mixed $value) : void
Parameters
$value : mixed

setPdfWhitespaces()

public setPdfWhitespaces(string $pdfWhitespaces) : void
Parameters
$pdfWhitespaces : string

setPdfWhitespacesRegex()

public setPdfWhitespacesRegex(string $pdfWhitespacesRegex) : void
Parameters
$pdfWhitespacesRegex : string

setRetainImageContent()

public setRetainImageContent(bool $retainImageContent) : void
Parameters
$retainImageContent : bool

        
On this page

Search results