SetaPDF_Extractor_Strategy_Plain Extraction strategy for plain text.

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

Class hierarchy

Summary

Properties

$_cleanStreamCallback

A callback that is called before processing a stream.

$_graphicState

$_ignoreFaultyStreams

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

$_items

$_keepIntersectingSpaces

Defines whether intersecting spaces should be ignored or not.

$_lastMatrix

$_resources

The stream resources dictionary.

$_sorter

$_textCount

A text item counter.

$spaceWidthFactor

A factor to calculate whether a distance can be seen as a character separator.

The fonts space character width is devided by this factor to define the minimum space for a character separator.


Methods

__construct()

_accept()

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

_cleanResult()

public SetaPDF_Extractor_Strategy_Plain::_cleanResult (
string $result
): string

Callback to clean up the resulting text.

Parameters
$result : string
 

_getParser()

Creates the content stream parser.

Parameters
$stream : string
 

_getSubInstance()

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

Parameters
$gs : SetaPDF_Core_Canvas_GraphicState
 

_ignore()

protected SetaPDF_Extractor_Strategy_Plain::_ignore (
string $string, string $prevString, SetaPDF_Extractor_TextItem $item, SetaPDF_Extractor_TextItem $prevItem
): boolean

Method to allow implementation of individual logic.

Parameters
$string : string
 
$prevString : string
 
$item : SetaPDF_Extractor_TextItem
 
$prevItem : SetaPDF_Extractor_TextItem
 

_onAfterShowText()

public SetaPDF_Extractor_Strategy_Plain::_onAfterShowText (
string $rawString
): void

Callback that is called after a show text operation was invoked.

Parameters
$rawString : string
 
Exceptions

Throws SetaPDF_Extractor_Exception

Throws SetaPDF_Core_Exception

_onBeforeShowText()

Callback that is called before a show text operation is invoked.

_onBeginOrEndText()

public SetaPDF_Extractor_Strategy_Plain::_onBeginOrEndText (
array $arguments, string $operator
): void

Callback for begin or end text operators (BT/ET).

Parameters
$arguments : array
 
$operator : string
 

_onCurrentTransformationMatrix()

public SetaPDF_Extractor_Strategy_Plain::_onCurrentTransformationMatrix (
array $arguments, string $operator
): void

Callback for ctm changes (cm).

Parameters
$arguments : array
 
$operator : string
 

_onFormXObject()

public SetaPDF_Extractor_Strategy_Plain::_onFormXObject (
array $arguments, string $operator
): void

Callback for painting a specified XObject.

Parameters
$arguments : array
 
$operator : string
 
Exceptions

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Filter_Exception

_onGraphicStateChange()

public SetaPDF_Extractor_Strategy_Plain::_onGraphicStateChange (
array $arguments, string $operator
): void

Callback for graphic state changes operators (q/Q).

Parameters
$arguments : array
 
$operator : string
 

_onInlineImage()

public SetaPDF_Extractor_Strategy_Plain::_onInlineImage (
array $arguments, string $operator
): false|void

Callback for inline image operator

Parameters
$arguments : array
 
$operator : string
 

_onTextPosition()

public SetaPDF_Extractor_Strategy_Plain::_onTextPosition (
array $arguments, string $operator
): void

Callback for text position operators.

Parameters
$arguments : array
 
$operator : string
 

_onTextShow()

public SetaPDF_Extractor_Strategy_Plain::_onTextShow (
array $arguments, string $operator
): void

Callback for text show operators.

Parameters
$arguments : array
 
$operator : string
 
Exceptions

Throws SetaPDF_Core_Exception

_onTextState()

public SetaPDF_Extractor_Strategy_Plain::_onTextState (
array $arguments, string $operator
): void

Callback for text state operators.

All states has to be passed to the current graphic state as defined in PDF 32000-1:2008, Table 52 on page 121.

Parameters
$arguments : array
 
$operator : string
 
Exceptions

Throws SetaPDF_Extractor_Exception

_saveLastMatrix()

protected SetaPDF_Extractor_Strategy_Plain::_saveLastMatrix (
string $type
): void

Saves the last matrix by a specific type.

Parameters
$type : string
 

getCleanStreamCallback()

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

getGraphicState()

getKeepIntersecingSpaces()

getKeepIntersectingSpaces()

Get a flag which defines whether intersecting spaces are ignored or not.

getResult()

public SetaPDF_Extractor_Strategy_Plain::getResult (
string $stream, SetaPDF_Core_Type_Dictionary $resources
): string|array

Get the plain text from a stream.

Parameters
$stream : string
 
$resources : SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws SetaPDF_Core_Exception

getSorter()

Get the sorter instance.

If none was set a base line sorter is created automatically.

process()

Processes a stream through the plain text strategy.

Parameters
$stream : string
 
$resources : SetaPDF_Core_Type_Dictionary
 

setBoundary()

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()

setGraphicState()

Set the graphic state.

Parameters
$graphicState : SetaPDF_Core_Canvas_GraphicState
 

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
 

setKeepIntersectingSpaces()

public SetaPDF_Extractor_Strategy_Plain::setKeepIntersectingSpaces (
[ bool $keep = true ]
): void

Set a flag which defines whether intersacting spaces are ignored or not.

By default this is set to false which removes a space or white-space character which intersects with another character for more than 55 percent.

Parameters
$keep : bool
 

setSorter()

Set a sorter instance.

Parameters
$sorter : SetaPDF_Extractor_Sorter