Class SpatialStorage in namespace setasign\SetaPDF2\Extractor\Storage in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Extractor
  1. Storage

setasign\SetaPDF2\Extractor\Storage

SpatialStorage The implementation of a spatial storage

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

Class hierarchy

SpatialStorage

Implements

StorageInterface

Summary

Properties

$_cellSize
$_cells
$_hashes
$_objects

Properties

$_cellSize

protected int|float SpatialStorage::$_cellSize

The given cell-size that will be used to hash the points.

$_cells

protected array SpatialStorage::$_cells = array()

The cells.

$_hashes

protected array SpatialStorage::$_hashes = array()

All hashes.

$_objects

protected SpatialStorage::$_objects = array()

Methods

__construct()

public SpatialStorage::__construct (

int|float $cellSize

)

The constructor.

Parameters

$cellSize : int|float

_getCoordinateRange()

protected SpatialStorage::_getCoordinateRange (

\SetaPDF_Core_Geometry_Rectangle|\SetaPDF_Core_Geometry_Point $geometry

): array

Creates a coordinate range for a geometry.

Parameters

$geometry : \SetaPDF_Core_Geometry_Rectangle|\SetaPDF_Core_Geometry_Point

_getHashes()

protected SpatialStorage::_getHashes (

\SetaPDF_Extractor_Storage_StorageEntry $entry

): array

Gets the hashes for a storage entry.

Parameters

$entry : \SetaPDF_Extractor_Storage_StorageEntry

_hash()

protected SpatialStorage::_hash (

\SetaPDF_Core_Geometry_Point $p

): array

Creates a hash for a given point.

Parameters

$p : \SetaPDF_Core_Geometry_Point

clear()

public SpatialStorage::clear (

void

): void

Removes all entries from the storage and cleans up.

get()

public SpatialStorage::get (

\SetaPDF_Core_Geometry_Rectangle|\SetaPDF_Core_Geometry_Point $geometry

): \SetaPDF_Extractor_Storage_StorageEntry[]

Get all entries intersecting with the given geometry.

Parameters

$geometry : \SetaPDF_Core_Geometry_Rectangle|\SetaPDF_Core_Geometry_Point

getFirstAvailable()

public SpatialStorage::getFirstAvailable (

void

): \SetaPDF_Extractor_Storage_StorageEntry|false

Get the first available storage-entry or false.

getIntersecting()

public SpatialStorage::getIntersecting (

\SetaPDF_Extractor_Storage_StorageEntry $entry

): \SetaPDF_Extractor_Storage_StorageEntry[]

Get all entries intersecting with the given entry.

Parameters

$entry : \SetaPDF_Extractor_Storage_StorageEntry

insert()

public SpatialStorage::insert (

\SetaPDF_Core_Geometry_Point|\SetaPDF_Core_Geometry_Rectangle $geometry,
mixed $data

): \SetaPDF_Extractor_Storage_StorageEntry

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

Parameters

$geometry : \SetaPDF_Core_Geometry_Point|\SetaPDF_Core_Geometry_Rectangle
$data : mixed

insertEntry()

public SpatialStorage::insertEntry (

\SetaPDF_Extractor_Storage_StorageEntry $entry

): \SetaPDF_Extractor_Storage_StorageEntry

Insert an entry into the storage.

Parameters

$entry : \SetaPDF_Extractor_Storage_StorageEntry

removeEntry()

public SpatialStorage::removeEntry (

\SetaPDF_Extractor_Storage_StorageEntry $entry

): \SetaPDF_Extractor_Storage_StorageEntry

Remove an entry from the storage.

Parameters

$entry : \SetaPDF_Extractor_Storage_StorageEntry