Class SetaPDF_Extractor_Result_WordWithGlyphs in SetaPDF v2 API Reference

Index

\SetaPDF
1. Extractor
2. Extractor
  1. Result
    1. Bounds
    2. Collection
    3. CompareableInterface
    4. Glyph
    5. HasBoundsInterface
    6. Segment
    7. Word
    8. WordGroups
    9. WordInterface
    10. WordWithGlyphs
    11. Words

SetaPDF_Extractor_Result_WordWithGlyphs This class represnts a single word including its glyphs

File: /SetaPDF v2/Extractor/Result/WordWithGlyphs.php

Class hierarchy

SetaPDF_Extractor_Result_WordWithGlyphs

Implements

Summary

Properties

$_bounds

protected ?SetaPDF_Extractor_Result_Bounds[] SetaPDF_Extractor_Result_WordWithGlyphs::$_bounds

The bounds of this word.

$_delimiterType

protected int SetaPDF_Extractor_Result_WordWithGlyphs::$_delimiterType

The delimiter type of the word.

$_glyphs

protected SetaPDF_Extractor_Result_Glyph[] SetaPDF_Extractor_Result_WordWithGlyphs::$_glyphs

The glyphs of this word.

$_parts

protected self[] SetaPDF_Extractor_Result_WordWithGlyphs::$_parts = array()

The initial words that were used to create this word.

$_word

protected array SetaPDF_Extractor_Result_WordWithGlyphs::$_word = array()

The resulting word in a specific encoding.

Static Methods

merge()

public static SetaPDF_Extractor_Result_WordWithGlyphs::merge (

SetaPDF_Extractor_Result_WordWithGlyphs $a,
SetaPDF_Extractor_Result_WordWithGlyphs $b,
string $resultingString = null

): SetaPDF_Extractor_Result_WordWithGlyphs

Merges two SetaPDF_Extractor_Result_WordWithGlyphs instances into a new one.

The words text-content will be $resultingString.

Parameters

$a : SetaPDF_Extractor_Result_WordWithGlyphs
$b : SetaPDF_Extractor_Result_WordWithGlyphs
$resultingString : string: In UTF-8 encoding.

Exceptions

Throws ReflectionException

Methods

__construct()

public SetaPDF_Extractor_Result_WordWithGlyphs::__construct (

SetaPDF_Extractor_Result_Glyph[] $glyphs,
int $delimiterType = 0

)

The constructor.

Parameters

$glyphs : SetaPDF_Extractor_Result_Glyph[]
$delimiterType : int

__toString()

public SetaPDF_Extractor_Result_WordWithGlyphs::__toString (

void

): string

Implementation of the magic method __toString().

See

cleanUp()

public SetaPDF_Extractor_Result_WordWithGlyphs::cleanUp (

void

): void

Release memory and cycled references

getBounds()

public SetaPDF_Extractor_Result_WordWithGlyphs::getBounds (

void

): SetaPDF_Extractor_Result_Bounds[]

Get the bounds of this word.

Exceptions

Throws SetaPDF_Core_Exception

getDelimiterType()

public SetaPDF_Extractor_Result_WordWithGlyphs::getDelimiterType (

void

): int

Get the delimiter type.

getFilterId()

public SetaPDF_Extractor_Result_WordWithGlyphs::getFilterId (

void

): ?string

Get the id of the filter instance that accepted this result.

getGlyphs()

public SetaPDF_Extractor_Result_WordWithGlyphs::getGlyphs (

void

): SetaPDF_Extractor_Result_Glyph[]

Get the glyphs of this word.

getParts()

public SetaPDF_Extractor_Result_WordWithGlyphs::getParts (

void

): self[]

Get all parts of this word.

If the word is not created by several words, this method will return itself.

getString()

public SetaPDF_Extractor_Result_WordWithGlyphs::getString (

string $encoding = 'utf-8'

): string

Get the words string value in a specific encoding.

Parameters

$encoding : string

setDelimiterType()

public SetaPDF_Extractor_Result_WordWithGlyphs::setDelimiterType (

int $delimiterType

): void

Set the delimiter type.

Parameters

$delimiterType : int