longitude-one/doctrine-spatial

<?php
/**
 * This file is part of the doctrine spatial extension.
 *
 * PHP          8.1 | 8.2 | 8.3
 * Doctrine ORM 2.19 | 3.1
 *
 * Copyright Alexandre Tranchant <alexandre.tranchant@gmail.com> 2017-2024
 * Copyright Longitude One 2020-2024
 * Copyright 2015 Derek J. Lambert
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 */

declare(strict_types=1);

namespace LongitudeOne\Spatial\PHP\Types;

use LongitudeOne\Spatial\Exception\InvalidValueException;

/**
 * Abstract MultiPoint object for MULTIPOINT spatial types.
 */
abstract class AbstractMultiPoint extends AbstractGeometry
{
    /**
     * @var (float|int)[][] Points
     */
    protected array $points = [];

    /**
     * Abstract multipoint constructor.
     *
     * @param ((float|int)[]|PointInterface)[] $points array of point
     * @param null|int                         $srid   Spatial Reference System Identifier
     *
     * @throws InvalidValueException when a point is not valid
     */
    public function __construct(array $points, ?int $srid = null)
    {
        $this->setPoints($points)
            ->setSrid($srid)
        ;
    }

    /**
     * Add a point to geometry.
     *
     * @param (float|int)[]|PointInterface $point Point to add to geometry
     *
     * @throws InvalidValueException when the point is not valid
     */
    public function addPoint(array|PointInterface $point): self
    {
        $this->points[] = $this->validatePointValue($point);

        return $this;
    }

    /**
     * Point getter.
     *
     * @param int $index index of the point to retrieve. -1 to get the last point.
     */
    public function getPoint(int $index): PointInterface
    {
        // TODO throw an error when index is out of range
        // TODO throw an error when $this->points is empty

        $point = match ($index) {
            -1 => $this->points[count($this->points) - 1],
            default => $this->points[$index],
        };

        /** @var class-string<PointInterface> $pointClass */
        $pointClass = $this->getNamespace().'\Point';

        return new $pointClass($point[0], $point[1], $this->srid);
    }

    /**
     * Points getter.
     *
     * @return PointInterface[]
     */
    public function getPoints(): array
    {
        $points = [];

        for ($i = 0; $i < count($this->points); ++$i) {
            $points[] = $this->getPoint($i);
        }

        return $points;
    }

    /**
     * Type getter.
     *
     * @return string Multipoint
     */
    public function getType(): string
    {
        return self::MULTIPOINT;
    }

    /**
     * Points fluent setter.
     *
     * @param ((float|int)[]|PointInterface)[] $points the points
     *
     * @throws InvalidValueException when a point is invalid
     */
    public function setPoints($points): self
    {
        $this->points = $this->validateMultiPointValue($points);

        return $this;
    }

    /**
     * Convert multipoint to array.
     *
     * @return (float|int)[][]
     */
    public function toArray(): array
    {
        return $this->points;
    }
}