README

Doctrine types & functions for brick/geo

Introduction

This library provides:

• type mappings to use brick/geo objects such as Polygon as Doctrine entity properties
• functions to use in DQL queries, such as Distance() or Contains().

Installation

This library is installable via Composer:

composer require brick/geo-doctrine

Requirements

This library requires PHP 8.1.

Project status & release process

The current releases are numbered 0.x.y. When a non-breaking change is introduced (adding new methods, optimizing existing code, etc.), y is incremented.

When a breaking change is introduced, a new 0.x version cycle is always started.

It is therefore safe to lock your project to a given release cycle, such as 0.5.*.

If you need to upgrade to a newer release cycle, check the release history for a list of changes introduced by each further 0.x.0 version.

Package contents

Types

• GeometryCollectionType
• GeometryType
• LineStringType
• MultiLineStringType
• MultiPointType
• MultiPolygonType
• PointType
• PolygonType

DQL Functions

• Area
• Azimuth
• Boundary
• Buffer
• Centroid
• Contains
• ConvexHull
• Crosses
• Difference
• Disjoint
• Distance
• Envelope
• Equals
• Intersects
• IsClosed
• IsSimple
• IsValid
• Length
• LocateAlong
• LocateBetween
• MaxDistance
• Overlaps
• PointOnSurface
• Relate
• Simplify
• SnapToGrid
• SymDifference
• Touches
• Union
• Within