Interface SetaPDF_Extractor_Result_WordInterface in SetaPDF v2 API Reference

Index

\SetaPDF
1. Extractor
2. Extractor
  1. Result

SetaPDF_Extractor_Result_WordInterface A interface for word classes

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

Implemented in

Implements

Summary

Methods

__toString()
cleanUp()
getBounds()
getDelimiterType()
getFilterId()
getParts()
getString()
setDelimiterType()

Methods

__toString()

abstract public SetaPDF_Extractor_Result_WordInterface::__toString (

void

): string

Implementation of the magic method __toString().

See

cleanUp()

abstract public SetaPDF_Extractor_Result_WordInterface::cleanUp (

void

): void

Release memory and cycled references.

getBounds()

abstract public SetaPDF_Extractor_Result_HasBoundsInterface::getBounds (

void

): SetaPDF_Extractor_Result_Bounds[]

Returns the bounds of a specific item.

getDelimiterType()

abstract public SetaPDF_Extractor_Result_WordInterface::getDelimiterType (

void

): int

Get the delimiter type.

getFilterId()

abstract public SetaPDF_Extractor_Result_WordInterface::getFilterId (

void

): null|string

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

getParts()

abstract public SetaPDF_Extractor_Result_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 SetaPDF_Extractor_Result_WordInterface::getString (

[ string $encoding = 'utf-8' ]

): string

Get the words string value in a specific encoding.

Parameters

$encoding : string

setDelimiterType()

abstract public SetaPDF_Extractor_Result_WordInterface::setDelimiterType (

int $delimiterType

): void

Set the delimiter type.

Parameters

$delimiterType : int