* * @var LineString[] */ protected array $rings = []; /** * The coordinate system of each of the rings must match the one of the Polygon. * * @param CoordinateSystem $cs The coordinate system of the Polygon. * @param LineString ...$rings The rings that compose the Polygon, the first one being the exterior ring. * * @throws InvalidGeometryException If the resulting geometry is not valid for a sub-type of Polygon. * @throws CoordinateSystemException If different coordinate systems are used. */ public function __construct(CoordinateSystem $cs, LineString ...$rings) { parent::__construct($cs, ! $rings); if (! $rings) { return; } CoordinateSystem::check($this, ...$rings); $this->rings = $rings; } /** * Creates a non-empty Polygon composed of the given rings. * * @psalm-suppress UnsafeInstantiation * * @param LineString $exteriorRing The exterior ring. * @param LineString ...$interiorRings The interior rings, if any. * * @throws InvalidGeometryException If the resulting geometry is not valid for a sub-type of Polygon. * @throws CoordinateSystemException If the rings use different coordinate systems. */ public static function of(LineString $exteriorRing, LineString ...$interiorRings) : Polygon { return new static($exteriorRing->coordinateSystem(), $exteriorRing, ...$interiorRings); } /** * Returns the exterior ring of this Polygon. * * @throws EmptyGeometryException */ public function exteriorRing() : LineString { if ($this->isEmpty) { throw new EmptyGeometryException('An empty Polygon has no exterior ring.'); } return $this->rings[0]; } /** * Returns the number of interior rings in this Polygon. */ public function numInteriorRings() : int { if ($this->isEmpty) { return 0; } return count($this->rings) - 1; } /** * Returns the specified interior ring N in this Polygon. * * @param int $n The ring number, 1-based. * * @throws NoSuchGeometryException If there is no interior ring at this index. */ public function interiorRingN(int $n) : LineString { if ($n === 0 || ! isset($this->rings[$n])) { throw new NoSuchGeometryException('There is no interior ring in this Polygon at index ' . $n); } return $this->rings[$n]; } /** * Returns the interior rings in this Polygon. * * @return LineString[] */ public function interiorRings() : array { return array_slice($this->rings, 1); } /** * @noproxy */ public function geometryType() : string { return 'Polygon'; } /** * @noproxy */ public function geometryTypeBinary() : int { return Geometry::POLYGON; } public function toXY(): Polygon { if ($this->coordinateDimension() === 2) { return $this; } $cs = $this->coordinateSystem ->withZ(false) ->withM(false); $rings = array_map(fn(LineString $ring) => $ring->toXY(), $this->rings); return new Polygon($cs, ...$rings); } public function withoutZ(): Polygon { if (! $this->coordinateSystem->hasZ()) { return $this; } $cs = $this->coordinateSystem->withZ(false); $rings = array_map(fn(LineString $ring) => $ring->withoutZ(), $this->rings); return new Polygon($cs, ...$rings); } public function withoutM(): Polygon { if (! $this->coordinateSystem->hasM()) { return $this; } $cs = $this->coordinateSystem->withM(false); $rings = array_map(fn(LineString $ring) => $ring->withoutM(), $this->rings); return new Polygon($cs, ...$rings); } public function getBoundingBox() : BoundingBox { $boundingBox = new BoundingBox(); foreach ($this->rings as $ring) { $boundingBox = $boundingBox->extendedWithBoundingBox($ring->getBoundingBox()); } return $boundingBox; } public function toArray() : array { $result = []; foreach ($this->rings as $ring) { $result[] = $ring->toArray(); } return $result; } public function swapXY() : Geometry { $that = clone $this; foreach ($that->rings as & $ring) { $ring = $ring->swapXY(); } return $that; } /** * Returns the number of rings (exterior + interior) in this Polygon. * * Required by interface Countable. */ public function count() : int { return count($this->rings); } /** * Returns an iterator for the rings (exterior + interior) in this Polygon. * * Required by interface IteratorAggregate. * * @psalm-return ArrayIterator */ public function getIterator() : ArrayIterator { return new ArrayIterator($this->rings); } }