SetaPDF_Extractor_Strategy_Word Extraction strategy for single words.

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

The result of this strategy is sorted from top-left to bottom-right.

Each word is represented by an instance of SetaPDF_Extractor_Result_Word or SetaPDF_Extractor_Result_WordWithGlyphs.

This class allows you to receive a words boundary through the getBounds() method of the word instance.

Class hierarchy

Summary

Constants

DELIMITER_ITEMS_NOT_JOINING

Delimiter constant

DELIMITER_LINE

Delimiter constant

DELIMITER_NEXT_ITEM_DOES_NOT_JOIN

Delimiter constant

DELIMITER_NEXT_ITEM_IS_NOT_A_NUMBER

Delimiter constant

DELIMITER_NONWORD_CHARACTER

Delimiter constant

DELIMITER_NO_DECIMAL_SEPARATOR

Delimiter constant

DELIMITER_NO_NEXT_ITEM

Delimiter constant

DELIMITER_PREV_ITEM_IS_NOT_A_NUMBER

Delimiter constant

DELIMITER_PREV_WORD_IS_BUILD_BY_NON_WORD_CHARACTERS

DELIMITER_SPACE

Delimiter constant

DELIMITER_SPACE_CHARACTER

Delimiter constant

DETAIL_LEVEL_DEFAULT

public const string SetaPDF_Extractor_Strategy_Word::DETAIL_LEVEL_DEFAULT = 'default'

Detail level constant.

Default detail level resulting in instances of SetaPDF_Extractor_Result_Word.

DETAIL_LEVEL_GLYPHS

Detail level constant.

Extended detail level resulting in instances of SetaPDF_Extractor_Result_WordWithGlyphs.


Static Properties

$characters

static public string SetaPDF_Extractor_Strategy_Word::$characters = '\\-‐−—‑²­'

Additional UTF-8 sequences that should be handled as word characters

In outdated PHP 5.2 version this property could be used to extend the character classes.

"\x2D" 'HYPHEN-MINUS' (U+002D) "\xE2\x80\x90" 'HYPHEN' (U+2010) "\xE2\x88\x92" 'MINUS SIGN' (U+2212) "\xE2\x80\x94" 'EM DASH' (U+2014) "\xE2\x80\x91" 'NON-BREAKING HYPHEN' (U+2011) "\xC2\xB2" 'SUPERSCRIPT TWO' (U+00B2) "\xC2\xAD" 'SOFT HYPHEN' (U+00AD)


Properties

$_cleanStreamCallback

A callback that is called before processing a stream.

$_detailLevel

protected string SetaPDF_Extractor_Strategy_Word::$_detailLevel = 'default'

The detail level.

$_graphicState

$_ignoreFaultyStreams

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

$_ignoreSpaceCharacter

Defines whether space characters should be ignored or not.

$_items

$_keepIntersectingSpaces

Defines whether intersecting spaces should be ignored or not.

$_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 divided by this factor to define the minimum space for a character separator.


Static Methods

_isNonWordCharacter()

protected static SetaPDF_Extractor_Strategy_Word::_isNonWordCharacter (
string $character
): bool

Checks whether the character is a non word character.

Parameters
$character : string
 

getWords()

public static SetaPDF_Extractor_Strategy_Word::getWords (
string $text [, string $encoding = 'UTF-8' ]
): array

Helper method to split a string into words.

This helper allows you to split a string into words with the same logic that is used to resolve words by text items resolved from a PDF document.

Parameters
$text : string
 
$encoding : string
 

Methods

__construct()

_accept()

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

This strategy filters space characters automatically if specified (see setIgnoreSpaceCharacter().

Parameters
$textItem : SetaPDF_Extractor_TextItem
 
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Extractor_Exception

See

_cleanResult()

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

Callback to clean up the resulting text.

Parameters
$result : string
 

_createWord()

Creates a new word instance using the glyphs.

Parameters
$glyphs : SetaPDF_Extractor_Result_Glyph[]
 
$delemitterType
 
Exceptions

Throws SetaPDF_Core_Exception

_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
 

_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_Core_Exception

Throws SetaPDF_Core_Filter_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

_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

_processLine()

Process all text items of a line.

Parameters
$items : SetaPDF_Extractor_TextItem[]
 
Exceptions

Throws SetaPDF_Core_Exception

_showText()

protected SetaPDF_Extractor_Strategy_Glyph::_showText (
string $string
): void

Method that shows text.

Parameters
$string : string
 
Exceptions

Throws SetaPDF_Core_Exception

_showTextStrings()

public SetaPDF_Extractor_Strategy_Plain::_showTextStrings (
array $textStrings
): void

Callback that is called if text strings should be shown.

Parameters
$textStrings : array
 
Exceptions

Throws SetaPDF_Core_Exception

getCleanStreamCallback()

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

getDetailLevel()

Get the detail level of the expected result.

getGraphicState()

getIgnoreSpaceCharacter()

Gets whether a space character should be fetched or not.

getKeepIntersecingSpaces()

WARNING: This method is marked as deprecated!

Use getKeepIntersectingSpaces() instead.

getKeepIntersectingSpaces()

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

getResult()

Get all resolved words.

Parameters
$stream : string
 
$resources : SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

getSorter()

Get the sorter instance.

If none was set a baseline sorter is created automatically.

process()

Processes a stream through the plain text strategy.

Parameters
$stream : string
 
$resources : SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

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
 

setDetailLevel()

public SetaPDF_Extractor_Strategy_Word::setDetailLevel (
string $detailLevel
): void

Set the detail level of the result.

Parameters
$detailLevel : string
 

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
 

setIgnoreSpaceCharacter()

public SetaPDF_Extractor_Strategy_Glyph::setIgnoreSpaceCharacter (
[ bool $ignoreSpaceCharacter = true ]
): void

Defines whether a space character should be fetched or not.

If this is set to true, the strategy will use the found space character as a delimiter. If this is set to false (default), the strategy will calculate a delimiter by the distance of 2 characters/glyphs.

Parameters
$ignoreSpaceCharacter : bool
 

setKeepIntersectingSpaces()

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

Set a flag which defines whether interacting 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