SetaPDF v2 API Reference

Index

\SetaPDF
1. Extractor
2. Extractor

SetaPDF_Extractor The main class of the SetaPDF-Extractor Component

File: /SetaPDF v2/Extractor.php

Class hierarchy

SetaPDF_Extractor

Summary

Methods

__construct()
cleanUp()
getResultByPageNumber()
getStrategy()
setStrategy()

Properties

$_document
$_ignoreFaultyStreams
$_strategy

Constants

VERSION

Constants

VERSION

public const string SetaPDF_Extractor::VERSION = '2.42.0.1871'

The version

Properties

$_document

protected SetaPDF_Core_Document SetaPDF_Extractor::$_document

The document instance

$_ignoreFaultyStreams

protected bool SetaPDF_Extractor::$_ignoreFaultyStreams = false

Defines wether to continue when a stream cannot be decoded or not.

$_strategy

protected SetaPDF_Extractor_Strategy_AbstractStrategy SetaPDF_Extractor::$_strategy

The extraction strategy

Methods

__construct()

public SetaPDF_Extractor::__construct (

SetaPDF_Core_Document $document [, SetaPDF_Extractor_Strategy_AbstractStrategy|null $strategy = null [, bool $ignoreFaultyStreams = false ]]

)

The constructor.

Parameters

$document : SetaPDF_Core_Document
$strategy : SetaPDF_Extractor_Strategy_AbstractStrategy|null
$ignoreFaultyStreams : bool

cleanUp()

public SetaPDF_Extractor::cleanUp (

void

): void

Release cycled references.

getResultByPageNumber()

public SetaPDF_Extractor::getResultByPageNumber (

integer $pageNumber [, string $boundaryBox = null ]

): SetaPDF_Extractor_Result_Collection|SetaPDF_Extractor_Result_Words|SetaPDF_Extractor_Result_WordGroups|string|string[]

Get the result by the default or individual strategy of a specific page.

Parameters

$pageNumber : integer
$boundaryBox : string: If set the page boundary is used to limit the result to the rectangle of the given boundary. See SetaPDF_Core_PageBoundaries::XXX_BOX constants for possible values.

Exceptions

Throws SetaPDF_Core_Exception

See

SetaPDF_Extractor::setStrategy()

getStrategy()

public SetaPDF_Extractor::getStrategy (

void

): SetaPDF_Extractor_Strategy_AbstractStrategy|SetaPDF_Extractor_Strategy_Plain

Get the extraction strategy.

setStrategy()

public SetaPDF_Extractor::setStrategy (

SetaPDF_Extractor_Strategy_AbstractStrategy $strategy

): void

Set the extraction strategy.

Parameters

$strategy : SetaPDF_Extractor_Strategy_AbstractStrategy