MySQLCompiler.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\MySQL;

use Cycle\Database\Query\Enum\LockMode;
use Cycle\Database\Query\Enum\LockBehavior;
use Cycle\Database\Driver\CachingCompilerInterface;
use Cycle\Database\Driver\Compiler;
use Cycle\Database\Driver\MySQL\Injection\CompileJson;
use Cycle\Database\Driver\Quoter;
use Cycle\Database\Injection\FragmentInterface;
use Cycle\Database\Injection\Parameter;
use Cycle\Database\Query\QueryParameters;

/**
 * MySQL syntax specific compiler.
 */
class MySQLCompiler extends Compiler implements CachingCompilerInterface
{
    protected function insertQuery(QueryParameters $params, Quoter $q, array $tokens): string
    {
        if ($tokens['columns'] === []) {
            return \sprintf(
                'INSERT INTO %s () VALUES ()',
                $this->name($params, $q, $tokens['table'], true),
            );
        }

        return parent::insertQuery($params, $q, $tokens);
    }

    /**
     *
     *
     * @link http://dev.mysql.com/doc/refman/5.0/en/select.html#id4651990
     */
    protected function limit(QueryParameters $params, Quoter $q, ?int $limit = null, ?int $offset = null): string
    {
        if ($limit === null && $offset === null) {
            return '';
        }

        $statement = '';
        if ($limit === null) {
            // When limit is not provided (or 0) but offset does we can replace
            // limit value with PHP_INT_MAX
            $statement .= 'LIMIT 18446744073709551615 ';
        } else {
            $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);
    }

    /**
     * @param array{mode: LockMode, behavior: LockBehavior}|null $forUpdate
     */
    protected function forUpdate(?array $forUpdate): string
    {
        if ($forUpdate !== null) {
            $arguments = [];

            switch ($forUpdate['mode']) {
                case LockMode::Share:
                case LockMode::KeyShare:
                    $arguments[] = 'SHARE';
                    break;
                case LockMode::Update:
                case LockMode::NoKeyUpdate:
                    $arguments[] = 'UPDATE';
                    break;
            }

            switch ($forUpdate['behavior']) {
                case LockBehavior::Wait:
                    break;
                case LockBehavior::NoWait:
                    $arguments[] = 'NOWAIT';
                    break;
                case LockBehavior::SkipLocked:
                    $arguments[] = 'SKIP LOCKED';
                    break;
            }

            return \sprintf('FOR %s', \implode(' ', $arguments));
        }

        return '';
    }
}