Interface StorageInterface in namespace setasign\SetaPDF2\Extractor\Storage in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Extractor
  1. Storage

setasign\SetaPDF2\Extractor\Storage

StorageInterface A interface to implement different storage types

File: /SetaPDF v2/Extractor/Storage/StorageInterface.php
Old class name (alias): \SetaPDF_Extractor_Storage_StorageInterface

Implemented in

SpatialStorage

Summary

Methods

clear()

abstract public StorageInterface::clear (

void

): void

Removes all entries from the storage and cleans up.

get()

abstract public StorageInterface::get (

\setasign\SetaPDF2\Core\Geometry\Rectangle|\setasign\SetaPDF2\Core\Geometry\Point $geometry

): StorageEntry[]

Get all entries intersecting with the given geometry.

Parameters

$geometry : \setasign\SetaPDF2\Core\Geometry\Rectangle|\setasign\SetaPDF2\Core\Geometry\Point

getFirstAvailable()

abstract public StorageInterface::getFirstAvailable (

void

): StorageEntry|false

Get the first available storage-entry or false.

getIntersecting()

abstract public StorageInterface::getIntersecting (

StorageEntry $entry

): StorageEntry[]

Get all entries intersecting with the given entry.

Parameters

$entry : StorageEntry

insert()

abstract public StorageInterface::insert (

\setasign\SetaPDF2\Core\Geometry\Point|\setasign\SetaPDF2\Core\Geometry\Rectangle $geometry,
mixed $data

): StorageEntry

Create a new entry for the data using the geometry and inserts it into the storage.

Parameters

$geometry : \setasign\SetaPDF2\Core\Geometry\Point|\setasign\SetaPDF2\Core\Geometry\Rectangle
$data : mixed

insertEntry()

abstract public StorageInterface::insertEntry (

StorageEntry $entry

): StorageEntry

Insert an entry into the storage.

Parameters

$entry : StorageEntry

removeEntry()

abstract public StorageInterface::removeEntry (

StorageEntry $entry

): StorageEntry

Remove an entry from the storage.

Parameters

$entry : StorageEntry