Class Extractor in namespace setasign\SetaPDF2\Extractor in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Extractor
  1. ContentStreamCleaner
  2. Exception
  3. Extractor
  4. Filter
  5. Result
  6. Sorter
  7. Storage
  8. Strategy
  9. TextItem

setasign\SetaPDF2\Extractor

Extractor The main class of the SetaPDF-Extractor Component

File: /SetaPDF v2/Extractor/Extractor.php
Old class name (alias): \SetaPDF_Extractor

Class hierarchy

Extractor

Summary

Constants

VERSION

public const string Extractor::VERSION = '2.47.0.2095'

The version

Properties

$_document

protected \SetaPDF_Core_Document Extractor::$_document

The document instance

$_ignoreFaultyStreams

protected bool Extractor::$_ignoreFaultyStreams = false

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

$_strategy

protected \SetaPDF_Extractor_Strategy_AbstractStrategy Extractor::$_strategy

The extraction strategy

Methods

__construct()

public Extractor::__construct (

\SetaPDF_Core_Document $document,
?\SetaPDF_Extractor_Strategy_AbstractStrategy $strategy = null,
bool $ignoreFaultyStreams = false

)

The constructor.

Parameters

$document : \SetaPDF_Core_Document
$strategy : ?\SetaPDF_Extractor_Strategy_AbstractStrategy
$ignoreFaultyStreams : bool

cleanUp()

public Extractor::cleanUp (

void

): void

Release cycled references.

getResultByPageNumber()

public Extractor::getResultByPageNumber (

int $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 : int
$boundaryBox : string: If set the page boundary is used to limit the result to the rectangle of the given boundary. See \setasign\SetaPDF2\Core\PageBoundaries::XXX_BOX constants for possible values.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

See

Extractor::setStrategy()

getStrategy()

public Extractor::getStrategy (

void

): \SetaPDF_Extractor_Strategy_AbstractStrategy|\SetaPDF_Extractor_Strategy_Plain

Get the extraction strategy.

setStrategy()

public Extractor::setStrategy (

\SetaPDF_Extractor_Strategy_AbstractStrategy $strategy

): void

Set the extraction strategy.

Parameters

$strategy : \SetaPDF_Extractor_Strategy_AbstractStrategy