Class MultiFilter in namespace setasign\SetaPDF2\Extractor\Filter in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Extractor
  1. Filter

setasign\SetaPDF2\Extractor\Filter

MultiFilter The multi filter allows you to create a filter by several filter instances.

File: /SetaPDF v2/Extractor/Filter/MultiFilter.php
Old class name (alias): \SetaPDF_Extractor_Filter_Multi

The filters are evaluated by an OR logic by default. If one of the filters match, the item will be accepted. It is also possible to use the filter with an AND logic by passing the mode constant to its snd parameter of the constructor.

Class hierarchy

MultiFilter

Implements

Summary

Constants

MODE_AND

public const string MultiFilter::MODE_AND = 'and'

A mode constant.

Defines that the filter should work in "and"-mode: All filters have to accept the text item.

MODE_OR

public const string MultiFilter::MODE_OR = 'or'

A mode constant.

Defines that the filter should work in "or"-mode: At least one filter have to accept the text item.

Properties

$_filters

protected \SetaPDF_Extractor_Filter_FilterInterface[] MultiFilter::$_filters = array()

The filter instances.e

$_id

protected ?string MultiFilter::$_id

The id of this filter.

$_mode

protected string MultiFilter::$_mode = 'or'

The mode to work with.

Methods

__construct()

public MultiFilter::__construct (

\SetaPDF_Extractor_Filter_FilterInterface|\SetaPDF_Extractor_Filter_FilterInterface[] $filters = array ( ),
string $mode = MultiFilter ::MODE_OR,
?string $id = null

)

The constructor.

Parameters

$filters : \SetaPDF_Extractor_Filter_FilterInterface|\SetaPDF_Extractor_Filter_FilterInterface[]: ,...
$mode : string
$id : ?string: The id for this filter.

accept()

public MultiFilter::accept (

\SetaPDF_Extractor_TextItem $textItem

): bool

Checks if this filter accepts the text item.

Parameters

$textItem : \SetaPDF_Extractor_TextItem

Return Values

True or false whether the item is accepted or not.

addFilter()

public MultiFilter::addFilter (

\SetaPDF_Extractor_Filter_FilterInterface $filter

): void

Adds an individual filter.

Parameters

$filter : \SetaPDF_Extractor_Filter_FilterInterface

getFilters()

public MultiFilter::getFilters (

void

): \SetaPDF_Extractor_Filter_FilterInterface[]

Get all filters.

getId()

public MultiFilter::getId (

void

): ?string

Get the filter id.

getMode()

public MultiFilter::getMode (

void

): string

Get the mode.

resetFilters()

public MultiFilter::resetFilters (

void

): void

Reset all filters.

setPage()

public MultiFilter::setPage (

\SetaPDF_Core_Document_Page $page

): void

Set the current page object for the specific filter.

Parameters

$page : \SetaPDF_Core_Document_Page