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

Index

\setasign\SetaPDF2
1. Extractor
  1. Filter

setasign\SetaPDF2\Extractor\Filter

RectangleFilter A rectangle filter.

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

This filter allows you to define a rectangle which is used to filter text items. This filter automatically takes care of rotated pages/coordinate systems.

The origin of the coordinate system is the lower left throughout.

Class hierarchy

RectangleFilter

Implements

Summary

Constants

MODE_CONTACT

public const string RectangleFilter::MODE_CONTACT = 'contact'

A mode constant.

This mode says that the text item has to contact the rectangle of this filter instance through any point or intersection.

MODE_CONTAINS

public const string RectangleFilter::MODE_CONTAINS = 'contains'

A mode constant.

This mode says that the whole text item has to be contained by the rectangle of this filter instance.

Properties

$_id

protected ?string RectangleFilter::$_id

The id of this filter.

$_mode

protected string RectangleFilter::$_mode = 'contact'

The mode to work with.

$_page

protected \SetaPDF_Core_Document_Page RectangleFilter::$_page

The current page object.

$_rectangle

protected \SetaPDF_Core_Geometry_Rectangle RectangleFilter::$_rectangle

The rectangle to filter by.

$_rotation

protected int RectangleFilter::$_rotation = 0

The rotation value.

$_transformedRectangle

protected \SetaPDF_Core_Geometry_Rectangle RectangleFilter::$_transformedRectangle

The rotated rectangle (if needed).

Methods

__construct()

public RectangleFilter::__construct (

\SetaPDF_Core_Geometry_Rectangle $rectangle,
string $mode = RectangleFilter ::MODE_CONTACT,
?string $id = null

)

The constructor.

The filter can work in 2 modes, which can be controlled by the 2nd paramter of the constructor:

MODE_CONTACT: This mode will match tangent items.
MODE_CONTAINS: This mode will match if the rectangle contains the whole text item.

Parameters

$rectangle : \SetaPDF_Core_Geometry_Rectangle: The rectangle to filter by.
$mode : string: A mode constant.
$id : ?string: The filter id.

_contact()

protected RectangleFilter::_contact (

\SetaPDF_Extractor_TextItem $textItem

): bool

Checks whether the rectangle and the text items contacting each other.

Parameters

$textItem : \SetaPDF_Extractor_TextItem

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

_contains()

protected RectangleFilter::_contains (

\SetaPDF_Extractor_TextItem $textItem

): bool

Checks whether the rectangle contains the item or not.

Parameters

$textItem : \SetaPDF_Extractor_TextItem

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

accept()

public RectangleFilter::accept (

\SetaPDF_Extractor_TextItem $textItem

): bool|string

Method that is called to decide if a text item accepted or not.

Parameters

$textItem : \SetaPDF_Extractor_TextItem

Exceptions

Throws \setasign\SetaPDF2\Extractor\Exception

Throws \setasign\SetaPDF2\Core\Exception

See

FilterInterface::accept()

getId()

public RectangleFilter::getId (

void

): ?string

Get the filter id.

getMode()

public RectangleFilter::getMode (

void

): string

Get the mode.

getRectangle()

public RectangleFilter::getRectangle (

bool $ignoreTransform = false

): \SetaPDF_Core_Geometry_Rectangle

Get the rectangle.

Parameters

$ignoreTransform : bool: Whether to ignore the transformation (rotation and translation of the page coordinate syste) or not.

setPage()

public RectangleFilter::setPage (

\SetaPDF_Core_Document_Page $page

): void

Set the current page object.

Parameters

$page : \SetaPDF_Core_Document_Page

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception