Index

  1. \SetaPDF
    1. Extractor
    2. Extractor
      1. Strategy
        1. AbstractStrategy
        2. ExactPlain
        3. Glyph
        4. Plain
        5. Word
        6. WordGroup

SetaPDF_Extractor_Strategy_AbstractStrategy Abstract class representing an extraction strategy.

File: /SetaPDF v2/Extractor/Strategy/AbstractStrategy.php

Class hierarchy

Summary

Methods

Properties

Properties

$_boundaryFilter

protected null|SetaPDF_Extractor_Filter_Rectangle SetaPDF_Extractor_Strategy_AbstractStrategy::$_boundaryFilter

The boundary filter.

$_cleanStreamCallback

protected callable SetaPDF_Extractor_Strategy_AbstractStrategy::$_cleanStreamCallback

A callback that is called before processing a stream.

$_filter

protected null|SetaPDF_Extractor_Filter_FilterInterface SetaPDF_Extractor_Strategy_AbstractStrategy::$_filter

A filter.

$_ignoreFaultyStreams

protected bool SetaPDF_Extractor_Strategy_AbstractStrategy::$_ignoreFaultyStreams = false

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


Methods

__construct()

public SetaPDF_Extractor_Strategy_AbstractStrategy::__construct (
void
)

The constructor.

_accept()

protected SetaPDF_Extractor_Strategy_AbstractStrategy::_accept (): bool|string

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

Parameters
$textItem : SetaPDF_Extractor_TextItem
 
Exceptions

Throws SetaPDF_Extractor_Exception

Throws SetaPDF_Core_Exception

See

_getSubInstance()

protected SetaPDF_Extractor_Strategy_AbstractStrategy::_getSubInstance (): SetaPDF_Extractor_Strategy_AbstractStrategy

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

Parameters
$gs : SetaPDF_Core_Canvas_GraphicState
 

getBoundary()

public SetaPDF_Extractor_Strategy_AbstractStrategy::getBoundary (
void
): SetaPDF_Core_Geometry_Rectangle|null

getCleanStreamCallback()

public SetaPDF_Extractor_Strategy_AbstractStrategy::getCleanStreamCallback (
void
): callable|null

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

getFilter()

public SetaPDF_Extractor_Strategy_AbstractStrategy::getFilter (
void
): null|SetaPDF_Extractor_Filter_FilterInterface

Get the filter.

getResult()

abstract public SetaPDF_Extractor_Strategy_AbstractStrategy::getResult (
string $stream, SetaPDF_Core_Type_Dictionary $resources
): mixed

Get the strategy specific result.

Parameters
$stream : string
 
$resources : SetaPDF_Core_Type_Dictionary
 

process()

abstract public SetaPDF_Extractor_Strategy_AbstractStrategy::process (
string $stream, SetaPDF_Core_Type_Dictionary $resources
): SetaPDF_Extractor_TextItem[]

Processes a stream through this strategy.

The result is an array of SetaPDF_Extractor_TextItem instances.

Parameters
$stream : string
 
$resources : SetaPDF_Core_Type_Dictionary
 

setBoundary()

public SetaPDF_Extractor_Strategy_AbstractStrategy::setBoundary (
[ SetaPDF_Core_Geometry_Rectangle|null $boundary = null ]
): void

Sets the boundary for the current strategy.

Parameters
$boundary : SetaPDF_Core_Geometry_Rectangle|null
 

setCleanStreamCallback()

public SetaPDF_Extractor_Strategy_AbstractStrategy::setCleanStreamCallback (
[ callable|null $callback = null ]
): void

Set a callback that is called before processing a stream.

Parameters
$callback : callable|null
 

setFilter()

public SetaPDF_Extractor_Strategy_AbstractStrategy::setFilter (): void

Set a filter.

Parameters
$filter : SetaPDF_Extractor_Filter_FilterInterface|null
 

setIgnoreFaultyStreams()

public SetaPDF_Extractor_Strategy_AbstractStrategy::setIgnoreFaultyStreams (
boolean $ignoreFaultyStreams
): void

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

Parameters
$ignoreFaultyStreams : boolean
 

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