Interface WordInterface in namespace setasign\SetaPDF2\Extractor\Result in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. 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

setasign\SetaPDF2\Extractor\Result

WordInterface A interface for word classes

File: /SetaPDF v2/Extractor/Result/WordInterface.php
Old class name (alias): \SetaPDF_Extractor_Result_WordInterface

Implemented in

Implements

Summary

Methods

__toString()

abstract public WordInterface::__toString (

void

): string

Implementation of the magic method __toString().

See

cleanUp()

abstract public WordInterface::cleanUp (

void

): void

Release memory and cycled references.

getBounds()

abstract public HasBoundsInterface::getBounds (

void

): \SetaPDF_Extractor_Result_Bounds[]

Returns the bounds of a specific item.

getDelimiterType()

abstract public WordInterface::getDelimiterType (

void

): int

Get the delimiter type.

getFilterId()

abstract public WordInterface::getFilterId (

void

): ?string

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

getParts()

abstract public WordInterface::getParts (

void

): self[]

Get all parts of this word.

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

getString()

abstract public WordInterface::getString (

string $encoding = 'utf-8'

): string

Get the words string value in a specific encoding.

Parameters

$encoding : string

setDelimiterType()

abstract public WordInterface::setDelimiterType (

int $delimiterType

): void

Set the delimiter type.

Parameters

$delimiterType : int