Index

  1. \setasign\SetaPDF2
    1. Extractor
      1. Strategy
        1. AbstractStrategy
        2. ExactPlainStrategy
        3. GlyphStrategy
        4. PlainStrategy
        5. WordGroupStrategy
        6. WordStrategy

setasign\SetaPDF2\Extractor\Strategy

AbstractStrategy Abstract class representing an extraction strategy.

File: /SetaPDF v2/Extractor/Strategy/AbstractStrategy.php
Old class name (alias): \SetaPDF_Extractor_Strategy_AbstractStrategy

Class hierarchy

Summary

Methods

Properties

Properties

$_boundaryFilter

protected ?\setasign\SetaPDF2\Extractor\Filter\RectangleFilter AbstractStrategy::$_boundaryFilter

The boundary filter.

$_cleanStreamCallback

protected callable AbstractStrategy::$_cleanStreamCallback

A callback that is called before processing a stream.

$_filter

protected ?\setasign\SetaPDF2\Extractor\Filter\FilterInterface AbstractStrategy::$_filter

A filter.

$_ignoreFaultyStreams

protected bool AbstractStrategy::$_ignoreFaultyStreams = false

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


Methods

__construct()

public AbstractStrategy::__construct (
void
)

The constructor.

_accept()

protected AbstractStrategy::_accept (): bool|string

Proxy method that forwards the call to a filter instance if available.

Parameters
$textItem : \setasign\SetaPDF2\Extractor\TextItem
 
Exceptions

Throws \setasign\SetaPDF2\Extractor\Exception

Throws \setasign\SetaPDF2\Core\Exception

See

_filterTextItems()

protected AbstractStrategy::_filterTextItems (): array

A helper method to filter arrays of text-items.

Parameters
$textItems : \setasign\SetaPDF2\Extractor\TextItem[]
 
$filter : ?\setasign\SetaPDF2\Extractor\Filter\FilterInterface
 

_getSubInstance()

protected AbstractStrategy::_getSubInstance (): static

Get an instance of the same strategy for processing another stream (e.g. a Form XObject stream).

Parameters
$gs : \setasign\SetaPDF2\Core\Canvas\GraphicState
 

getBoundary()

public AbstractStrategy::getBoundary (
void
): ?\setasign\SetaPDF2\Core\Geometry\Rectangle

getCleanStreamCallback()

public AbstractStrategy::getCleanStreamCallback (
void
): ?callable

Get the callback that is called before a stream is processed.

getFilter()

public AbstractStrategy::getFilter (
void
): ?\setasign\SetaPDF2\Extractor\Filter\FilterInterface

Get the filter.

getResult()

abstract public AbstractStrategy::getResult (
string $stream,
\setasign\SetaPDF2\Core\Type\PdfDictionary $resources
): mixed

Get the strategy specific result.

Parameters
$stream : string
 
$resources : \setasign\SetaPDF2\Core\Type\PdfDictionary
 

getResultByTextItems()

abstract public AbstractStrategy::getResultByTextItems (): mixed

Get the result by previously gathered text items.

Parameters
$items : \setasign\SetaPDF2\Extractor\TextItem[]
 
$filter : ?\setasign\SetaPDF2\Extractor\Filter\FilterInterface
 

process()

abstract public AbstractStrategy::process (
string $stream,
\setasign\SetaPDF2\Core\Type\PdfDictionary $resources
): \setasign\SetaPDF2\Extractor\TextItem[]

Processes a stream through this strategy.

The result is an array of \setasign\SetaPDF2\Extractor\TextItem instances.

Parameters
$stream : string
 
$resources : \setasign\SetaPDF2\Core\Type\PdfDictionary
 

setBoundary()

public AbstractStrategy::setBoundary (): void

Sets the boundary for the current strategy.

Parameters
$boundary : ?\setasign\SetaPDF2\Core\Geometry\Rectangle
 

setCleanStreamCallback()

public AbstractStrategy::setCleanStreamCallback (
?callable $callback = null
): void

Set a callback that is called before processing a stream.

Parameters
$callback : ?callable
 

setFilter()

public AbstractStrategy::setFilter (): void

Set a filter.

Parameters
$filter : ?\setasign\SetaPDF2\Extractor\Filter\FilterInterface
 

setIgnoreFaultyStreams()

public AbstractStrategy::setIgnoreFaultyStreams (
bool $ignoreFaultyStreams
): void

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

Parameters
$ignoreFaultyStreams : bool
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)