Class SetaPDF_Extractor_Strategy_WordGroup in SetaPDF v2 API Reference

Index

\SetaPDF
1. Extractor
2. Extractor
  1. Strategy

SetaPDF_Extractor_Strategy_WordGroup Extraction strategy for word groups

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

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

Each group is represented by an instance of SetaPDF_Extractor_Result_Words.

This class allows you to receive a groups boundary through the getBounds() method.

Class hierarchy

SetaPDF_Extractor_Strategy_AbstractStrategy
- SetaPDF_Extractor_Strategy_Plain
  - SetaPDF_Extractor_Strategy_Glyph
    - SetaPDF_Extractor_Strategy_Word
      - SetaPDF_Extractor_Strategy_WordGroup

Summary

Constants

DELIMITER_ITEMS_NOT_JOINING

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_ITEMS_NOT_JOINING = 17

Delimiter constant

DELIMITER_LINE

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_LINE = 2

Delimiter constant

DELIMITER_NEXT_ITEM_DOES_NOT_JOIN

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_NEXT_ITEM_DOES_NOT_JOIN = 1024

Delimiter constant

DELIMITER_NEXT_ITEM_IS_NOT_A_NUMBER

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_NEXT_ITEM_IS_NOT_A_NUMBER = 128

Delimiter constant

DELIMITER_NONWORD_CHARACTER

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_NONWORD_CHARACTER = 4

Delimiter constant

DELIMITER_NO_DECIMAL_SEPARATOR

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_NO_DECIMAL_SEPARATOR = 32

Delimiter constant

DELIMITER_NO_NEXT_ITEM

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_NO_NEXT_ITEM = 64

Delimiter constant

DELIMITER_PREV_ITEM_IS_NOT_A_NUMBER

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_PREV_ITEM_IS_NOT_A_NUMBER = 256

Delimiter constant

DELIMITER_PREV_WORD_IS_BUILD_BY_NON_WORD_CHARACTERS

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_PREV_WORD_IS_BUILD_BY_NON_WORD_CHARACTERS = 512

Delimiter constant

DELIMITER_SPACE

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_SPACE = 1

Delimiter constant

DELIMITER_SPACE_CHARACTER

public const integer SetaPDF_Extractor_Strategy_Word::DELIMITER_SPACE_CHARACTER = 9

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

public const string SetaPDF_Extractor_Strategy_Word::DETAIL_LEVEL_GLYPHS = '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

$_allowedFontSizeDifference

protected float|int SetaPDF_Extractor_Strategy_WordGroup::$_allowedFontSizeDifference = 3

The allowed height difference.

$_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.

$_contentParser

protected SetaPDF_Core_Parser_Content SetaPDF_Extractor_Strategy_Plain::$_contentParser

$_detailLevel

protected string SetaPDF_Extractor_Strategy_Word::$_detailLevel = 'default'

The detail level.

$_filter

protected null|SetaPDF_Extractor_Filter_FilterInterface SetaPDF_Extractor_Strategy_AbstractStrategy::$_filter

A filter.

$_graphicState

protected SetaPDF_Core_Canvas_GraphicState SetaPDF_Extractor_Strategy_Plain::$_graphicState

The graphic state instance.

$_hyphens

protected string SetaPDF_Extractor_Strategy_WordGroup::$_hyphens = '-'

These characters are used as hyphens in the dehyphen logic.

"\x2D" 'HYPHEN-MINUS' (U+002D) "\xC2\xAD" 'Soft Hyphen (SHY)' (U+00AD)

$_ignoreFaultyStreams

protected bool SetaPDF_Extractor_Strategy_AbstractStrategy::$_ignoreFaultyStreams = false

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

$_ignoreSpaceCharacter

protected bool SetaPDF_Extractor_Strategy_Glyph::$_ignoreSpaceCharacter = false

Defines whether space characters should be ignored or not.

$_items

protected SetaPDF_Extractor_TextItem[] SetaPDF_Extractor_Strategy_Plain::$_items = array()

The text items.

$_keepIntersectingSpaces

protected bool SetaPDF_Extractor_Strategy_Plain::$_keepIntersectingSpaces = false

Defines whether intersecting spaces should be ignored or not.

$_rectScaleFactorX

protected float|int SetaPDF_Extractor_Strategy_WordGroup::$_rectScaleFactorX = 0.274

The value that is used to scale the word-bounding-box on the x-axis.

$_rectScaleFactorY

protected float|int SetaPDF_Extractor_Strategy_WordGroup::$_rectScaleFactorY = 0.2707

The value that is used to scale the word-bounding-box on the y-axis.

$_resources

protected SetaPDF_Core_Type_Dictionary SetaPDF_Extractor_Strategy_Plain::$_resources

The stream resources dictionary.

$_sorter

protected SetaPDF_Extractor_Sorter SetaPDF_Extractor_Strategy_Plain::$_sorter

The sorter instance.

$_storage

protected SetaPDF_Extractor_Storage_StorageInterface SetaPDF_Extractor_Strategy_WordGroup::$_storage

The storage.

$_textCount

protected int SetaPDF_Extractor_Strategy_Plain::$_textCount = 0

A text item counter.

$_useDehyphen

protected bool SetaPDF_Extractor_Strategy_WordGroup::$_useDehyphen = true

Defines whether the dehyphen logic should be executed or not.

$spaceWidthFactor

public float SetaPDF_Extractor_Strategy_Plain::$spaceWidthFactor = 2.0

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

public SetaPDF_Extractor_Strategy_WordGroup::__construct (

[ SetaPDF_Extractor_Storage_StorageInterface|null $storage = null ]

)

The constructor.

Parameters

$storage : SetaPDF_Extractor_Storage_StorageInterface|null

_accept()

protected SetaPDF_Extractor_Strategy_Glyph::_accept (

SetaPDF_Extractor_TextItem $textItem

): bool|string

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

_calculateFontSize()

protected SetaPDF_Extractor_Strategy_WordGroup::_calculateFontSize (

SetaPDF_Extractor_TextItem $textItem

): float

Calculates the font size of a text item in user space.

Parameters

$textItem : SetaPDF_Extractor_TextItem

_cleanResult()

public SetaPDF_Extractor_Strategy_Plain::_cleanResult (

string $result

): string

Callback to clean up the resulting text.

Parameters

$result : string

_createWord()

protected SetaPDF_Extractor_Strategy_Word::_createWord (

SetaPDF_Extractor_Result_Glyph[] $glyphs [, $delemitterType = 0 ]

): SetaPDF_Extractor_Result_WordWithGlyphs|SetaPDF_Extractor_Result_Word

Creates a new word instance using the glyphs.

Parameters

$glyphs : SetaPDF_Extractor_Result_Glyph[]
$delemitterType

Exceptions

Throws SetaPDF_Core_Exception

_dehyphen()

protected SetaPDF_Extractor_Strategy_WordGroup::_dehyphen (

array $group

): array

Executes the dehyphen logic.

Parameters

$group : array

Exceptions

Throws ReflectionException

Throws SetaPDF_Core_Exception

_getParser()

protected SetaPDF_Extractor_Strategy_Plain::_getParser (

string $stream

): SetaPDF_Core_Parser_Content

Creates the content stream parser.

Parameters

$stream : string

_getSubInstance()

public SetaPDF_Extractor_Strategy_WordGroup::_getSubInstance (

SetaPDF_Core_Canvas_GraphicState $gs

): SetaPDF_Extractor_Strategy_Glyph

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

_insertIntoStorage()

protected SetaPDF_Extractor_Strategy_WordGroup::_insertIntoStorage (

string $stream, SetaPDF_Core_Type_Dictionary $resources

): void

Prepares and fills the storage for resolving word groups.

Parameters

$stream : string
$resources : SetaPDF_Core_Type_Dictionary

Exceptions

Throws SetaPDF_Core_Exception

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

protected SetaPDF_Extractor_Strategy_Word::_processLine (

SetaPDF_Extractor_TextItem[] $items

): array

Process all text items of a line.

Parameters

$items : SetaPDF_Extractor_TextItem[]

Exceptions

Throws SetaPDF_Core_Exception

_resolveGroup()

protected SetaPDF_Extractor_Strategy_WordGroup::_resolveGroup (

SetaPDF_Extractor_Storage_StorageEntry $storageEntry

): SetaPDF_Extractor_Storage_StorageEntry[]

Resolves all intersecting entries of the storage, starting by a single entry.

Parameters

$storageEntry : SetaPDF_Extractor_Storage_StorageEntry

_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

getAllowedFontSizeDifference()

public SetaPDF_Extractor_Strategy_WordGroup::getAllowedFontSizeDifference (

void

): float|int

Gets the currently allowed font-size difference.

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.

getDehyphen()

public SetaPDF_Extractor_Strategy_WordGroup::getDehyphen (

void

): bool

Gets whether the dehyphen logic should be executed or not.

getDetailLevel()

public SetaPDF_Extractor_Strategy_Word::getDetailLevel (

void

): string

Get the detail level of the expected result.

getFilter()

public SetaPDF_Extractor_Strategy_AbstractStrategy::getFilter (

void

): null|SetaPDF_Extractor_Filter_FilterInterface

Get the filter.

getGraphicState()

public SetaPDF_Extractor_Strategy_Plain::getGraphicState (

void

): SetaPDF_Core_Canvas_GraphicState

Get the graphic state.

getIgnoreSpaceCharacter()

public SetaPDF_Extractor_Strategy_Glyph::getIgnoreSpaceCharacter (

void

): bool

Gets whether a space character should be fetched or not.

getKeepIntersecingSpaces()

WARNING: This method is marked as deprecated!

Use getKeepIntersectingSpaces() instead.

public SetaPDF_Extractor_Strategy_Plain::getKeepIntersecingSpaces (

void

): bool

getKeepIntersectingSpaces()

public SetaPDF_Extractor_Strategy_Plain::getKeepIntersectingSpaces (

void

): bool

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

getRectScaleFactorX()

public SetaPDF_Extractor_Strategy_WordGroup::getRectScaleFactorX (

void

): float|int

Gets the rect scale-factor for the abscissa.

getRectScaleFactorY()

public SetaPDF_Extractor_Strategy_WordGroup::getRectScaleFactorY (

void

): float|int

Gets the rect scale-factor for the ordinate.

getResult()

public SetaPDF_Extractor_Strategy_WordGroup::getResult (

string $stream, SetaPDF_Core_Type_Dictionary $resources

): SetaPDF_Extractor_Result_WordGroups

Get all resolved words groups.

Parameters

$stream : string
$resources : SetaPDF_Core_Type_Dictionary

Exceptions

Throws ReflectionException

Throws SetaPDF_Core_Exception

getSorter()

public SetaPDF_Extractor_Strategy_Plain::getSorter (

void

): SetaPDF_Extractor_Sorter|SetaPDF_Extractor_Sorter_Baseline

Get the sorter instance.

If none was set a baseline sorter is created automatically.

process()

public SetaPDF_Extractor_Strategy_Plain::process (

string $stream, SetaPDF_Core_Type_Dictionary $resources

): SetaPDF_Extractor_TextItem[]

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

setAllowedFontSizeDifference()

public SetaPDF_Extractor_Strategy_WordGroup::setAllowedFontSizeDifference (

float|int $value

): void

Sets the current allowed font-size difference.

Parameters

$value : float|int

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

setDehyphen()

public SetaPDF_Extractor_Strategy_WordGroup::setDehyphen (

bool $dehyphen [, string|null $hyphens = null ]

): void

Sets whether the dehyphen logic should be executed or not.

Parameters

$dehyphen : bool
$hyphens : string|null

setDetailLevel()

public SetaPDF_Extractor_Strategy_Word::setDetailLevel (

string $detailLevel

): void

Set the detail level of the result.

Parameters

$detailLevel : string

setFilter()

public SetaPDF_Extractor_Strategy_AbstractStrategy::setFilter (

[ SetaPDF_Extractor_Filter_FilterInterface|null $filter = null ]

): void

Set a filter.

Parameters

$filter : SetaPDF_Extractor_Filter_FilterInterface|null

setGraphicState()

public SetaPDF_Extractor_Strategy_Plain::setGraphicState (

SetaPDF_Core_Canvas_GraphicState $graphicState

): void

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.