MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\DateSubtract

Complexity

Total Complexity

6

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getNodeMappingPattern()	0	3	1
A	validateArguments()	0	10	4
A	customizeFunction()	0	3	1

<?php

declare(strict_types=1);

namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;

use Doctrine\ORM\Query\AST\Node;
use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Traits\TimezoneValidationTrait;

/**
 * Implementation of PostgreSQL DATE_SUBTRACT().
 *
 * Subtracts an interval from a timestamp with time zone, computing times of day and daylight-savings
 * adjustments according to the time zone.
 *
 * @see https://www.postgresql.org/docs/16/functions-datetime.html
 * @since 3.1
 *
 * @author Martin Georgiev <martin.georgiev@gmail.com>
 *
 * @example Using it in DQL: "SELECT DATE_SUBTRACT(e.timestampWithTz, '1 day', 'Europe/Sofia') FROM Entity e"
 */
class DateSubtract extends BaseVariadicFunction
{
    use TimezoneValidationTrait;

The trait MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Traits\TimezoneValidationTrait requires the property $value which is not provided by MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\DateSubtract.

    protected function getNodeMappingPattern(): array
    {
        return ['StringPrimary'];
    }

    protected function customizeFunction(): void
    {
        $this->setFunctionPrototype('date_subtract(%s)');
    }

    protected function validateArguments(Node ...$arguments): void
    {
        $argumentCount = \count($arguments);
        if ($argumentCount < 2 || $argumentCount > 3) {
            throw InvalidArgumentForVariadicFunctionException::between('date_subtract', 2, 3);
        }

        // Validate that the third parameter is a valid timezone if provided
        if ($argumentCount === 3) {
            $this->validateTimezone($arguments[2], 'DATE_SUBTRACT');
        }
    }
}