ページングしたときの総件数を得る関数を DQL に追加する

CountOver.php

<?php
/** @noinspection PhpUnused */

namespace App\DQL;


use Doctrine\ORM\Query\AST\Functions\FunctionNode;
use Doctrine\ORM\Query\Lexer;
use Doctrine\ORM\Query\Parser;
use Doctrine\ORM\Query\QueryException;
use Doctrine\ORM\Query\SqlWalker;

/**
 * Class CountOver
 *
 * ページングしたときの総件数を得る関数を DQL に追加する
 *
 * config/packages/doctrine.yaml の orm キーの下に次を記述する
 *
 * orm:
 *     dql:
 *         string_functions:
 *             count_over: App\DQL\CountOver
 *
 * 使用する際は `count_over()` で総件数を取得できる
 *
 * $query = $em->getQuery('SELECT t, count_over FROM App\Entity\Table t')
 * $query->setMaxResults(10)
 *     ->setFirstResult(11);
 * $result = $query->getResult();
 *
 * または QueryBuilder で
 *
 * $qb->select('count_over() as total');
 *
 * @package App\DQL
 */
class CountOver extends FunctionNode
{
    /**
     * @inheritDoc
     */
    public function getSql(SqlWalker $sqlWalker)
    {
        return "COUNT(*) OVER()";
    }

    /**
     * @inheritDoc
     * @throws QueryException
     */
    public function parse(Parser $parser): void
    {
        $parser->match(Lexer::T_IDENTIFIER);
        $parser->match(Lexer::T_OPEN_PARENTHESIS);
        $parser->match(Lexer::T_CLOSE_PARENTHESIS);
    }
}