MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\DateTrunc

Complexity

Total Complexity

9

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Test Coverage

Coverage

93.75%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	validateTruncField()	0	4	3
A	getMinArgumentCount()	0	3	1
A	getNodeMappingPattern()	0	3	1
A	getFunctionName()	0	3	1
A	getMaxArgumentCount()	0	3	1
A	validateArguments()	0	9	2

<?php

declare(strict_types=1);

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

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

/**
 * Implementation of PostgreSQL DATE_TRUNC().
 *
 * @see https://www.postgresql.org/docs/current/functions-datetime.html#FUNCTIONS-DATETIME-TRUNC
 * @since 3.7
 *
 * @author Jan Klan <jan@klan.com.au>
 *
 * @example Using it in DQL: "SELECT DATE_TRUNC('day', e.timestampWithTz, 'Australia/Adelaide') FROM Entity e"
 */
class DateTrunc 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\DateTrunc.

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

    protected function getFunctionName(): string
    {
        return 'date_trunc';
    }

    protected function getMinArgumentCount(): int
    {
        return 2;
    }

    protected function getMaxArgumentCount(): int
    {
        return 3;
    }

    protected function validateArguments(Node ...$arguments): void
    {
        parent::validateArguments(...$arguments);

        $this->validateTruncField($arguments[0]);

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

    /**
     * Validates that the given node represents a valid trunc field value.
     *
     * @throws InvalidTruncFieldException If the field value is invalid
     */
    protected function validateTruncField(Node $node): void
    {
        if (!$node instanceof Literal || !\is_string($node->value)) {
            throw InvalidTruncFieldException::forNonLiteralNode($node::class, $this->getFunctionName());
        }
    }
}