lib/LongitudeOne/Spatial/ORM/Query/AST/Functions/PostgreSql/SpLineSubstring.php
<?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\ORM\Query\AST\Functions\PostgreSql;
use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
use LongitudeOne\Spatial\ORM\Query\AST\Functions\AbstractSpatialDQLFunction;
use LongitudeOne\Spatial\ORM\Query\AST\Functions\ReturnsGeometryInterface;
/**
* ST_Line_Substring DQL function.
*
* @author Tom Vogt <tom@lemuria.org>
* @author Alexandre Tranchant <alexandre.tranchant@gmail.com>
* @license https://alexandre-tranchant.mit-license.org
*/
class SpLineSubstring extends AbstractSpatialDQLFunction implements ReturnsGeometryInterface
{
/**
* Function SQL name getter.
*
* @since 2.0 This function replace the protected property functionName.
*/
protected function getFunctionName(): string
{
// since Postgis 2.1 ST_Line_Substring renamed to ST_LineSubstring
// @see http://postgis.net/docs/manual-3.1/PostGIS_Special_Functions_Index.html#NewFunctions
return 'ST_LineSubstring';
}
/**
* Maximum number of parameter for the spatial function.
*
* @since 2.0 This function replace the protected property maxGeomExpr.
*
* @return int the inherited methods shall NOT return null, but 0 when function has no parameter
*/
protected function getMaxParameter(): int
{
return 3;
}
/**
* Minimum number of parameter for the spatial function.
*
* @since 2.0 This function replace the protected property minGeomExpr.
*
* @return int the inherited methods shall NOT return null, but 0 when function has no parameter
*/
protected function getMinParameter(): int
{
return 3;
}
/**
* Get the platforms accepted.
*
* @since 2.0 This function replace the protected property platforms.
* @since 5.0 This function returns the class-string[] instead of string[]
*
* @return class-string[] a non-empty array of accepted platforms
*/
protected function getPlatforms(): array
{
return [PostgreSQLPlatform::class];
}
}