PostgresCompiler.php

<?php

/**
 * This file is part of Cycle ORM package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cycle\Database\Driver\Postgres;

use Cycle\Database\Driver\CachingCompilerInterface;
use Cycle\Database\Driver\Compiler;
use Cycle\Database\Driver\Postgres\Injection\CompileJson;
use Cycle\Database\Driver\Quoter;
use Cycle\Database\Injection\FragmentInterface;
use Cycle\Database\Injection\Parameter;
use Cycle\Database\Query\QueryParameters;

/**
 * Postgres syntax specific compiler.
 */
class PostgresCompiler extends Compiler implements CachingCompilerInterface
{
    protected const ORDER_OPTIONS = [
        'ASC', 'ASC NULLS LAST', 'ASC NULLS FIRST' ,
        'DESC', 'DESC NULLS LAST', 'DESC NULLS FIRST',
    ];

    /**
     * @psalm-return non-empty-string
     */
    protected function insertQuery(QueryParameters $params, Quoter $q, array $tokens): string
    {
        $result = parent::insertQuery($params, $q, $tokens);

        if (empty($tokens['return'])) {
            return $result;
        }

        return \sprintf(
            '%s RETURNING %s',
            $result,
            \implode(',', \array_map(
                fn(string|FragmentInterface|null $return) => $return instanceof FragmentInterface
                    ? $this->fragment($params, $q, $return)
                    : $this->quoteIdentifier($return),
                $tokens['return'],
            )),
        );
    }

    /**
     * @psalm-return non-empty-string
     */
    protected function upsertQuery(QueryParameters $params, Quoter $q, array $tokens): string
    {
        $query = parent::upsertQuery($params, $q, $tokens);

        if (empty($tokens['return'])) {
            return $query;
        }

        return \sprintf(
            '%s RETURNING %s',
            $query,
            \implode(',', \array_map(
                fn(string|FragmentInterface|null $return) => $return instanceof FragmentInterface
                    ? $this->fragment($params, $q, $return)
                    : $this->quoteIdentifier($return),
                $tokens['return'],
            )),
        );
    }

    protected function distinct(QueryParameters $params, Quoter $q, string|bool|array $distinct): string
    {
        if ($distinct === false) {
            return '';
        }

        if (\is_array($distinct) && isset($distinct['on'])) {
            return \sprintf('DISTINCT ON (%s)', $this->name($params, $q, $distinct['on']));
        }

        if (\is_string($distinct)) {
            return \sprintf('DISTINCT (%s)', $this->name($params, $q, $distinct));
        }

        return 'DISTINCT';
    }

    protected function limit(QueryParameters $params, Quoter $q, ?int $limit = null, ?int $offset = null): string
    {
        if ($limit === null && $offset === null) {
            return '';
        }

        $statement = '';
        if ($limit !== null) {
            $statement = 'LIMIT ? ';
            $params->push(new Parameter($limit));
        }

        if ($offset !== null) {
            $statement .= 'OFFSET ?';
            $params->push(new Parameter($offset));
        }

        return \trim($statement);
    }

    protected function compileJsonOrderBy(string $path): FragmentInterface
    {
        return new CompileJson($path);
    }
}