b2pweb / bdf-prime

src/Query/Expression/Aggregate.php

<?php

namespace Bdf\Prime\Query\Expression;

use Bdf\Prime\Query\CompilableClause;
use Bdf\Prime\Query\Compiler\CompilerInterface;
use Bdf\Prime\Query\Compiler\QuoteCompilerInterface;
use Doctrine\DBAL\Platforms\AbstractPlatform;

/**
 * Aggregation expressions
 * Can be use on Query::select() method
 *
 * Usage:
 * <code>
 * User::select([
 *     'firstId' => Aggregate::min(id),
 *     'lastId' => Aggregate::max(id),
 *     'count' => Aggregate::count(id),
 * ]);
 * </code>
 *
 * @implements ExpressionInterface<CompilableClause&\Bdf\Prime\Query\Contract\Compilable, CompilerInterface&QuoteCompilerInterface>
 */
abstract class Aggregate implements ExpressionInterface
{
    /**
     * @var string
     */
    private $attribute;

    /**
     * Max constructor.
     *
     * @param string $attribute The attribute name
     */
    public function __construct(string $attribute)
    {
        $this->attribute = $attribute;
    }

    /**
     * {@inheritdoc}
     *
     * @param CompilerInterface&QuoteCompilerInterface $compiler
     */
    final public function build(CompilableClause $query, object $compiler)
    {
        $attribute = $this->attribute;

        if ($attribute !== '*') {
            $attribute = $compiler->quoteIdentifier($query, $query->preprocessor()->field($attribute));
        }

        return $this->expression($compiler->platform()->grammar(), $attribute);
    }

    /**
     * Get the aggregate expression
     *
     * @param AbstractPlatform $platform The database platform
     * @param string $attribute The attribute to aggregate
     *
     * @return string
     */
    abstract protected function expression(AbstractPlatform $platform, string $attribute): string;

    /**
     * Perform MIN() aggregation function
     *
     * @param string $attribute The attribute to aggregate
     *
     * @return self

The doc comment self at position 0 could not be parsed: 'self' is only available from within classes.

     */
    public static function min(string $attribute): self
    {
        return new class ($attribute) extends Aggregate {
            protected function expression(AbstractPlatform $platform, string $attribute): string
            {
                return $platform->getMinExpression($attribute);

The function Doctrine\DBAL\Platforms\AbstractPlatform::getMinExpression() has been deprecated: Use MIN() in SQL instead.

            }
        };
    }

    /**
     * Perform MAX() aggregation function
     *
     * @param string $attribute The attribute to aggregate
     *
     * @return self

The doc comment self at position 0 could not be parsed: 'self' is only available from within classes.

     */
    public static function max(string $attribute): self
    {
        return new class ($attribute) extends Aggregate {
            protected function expression(AbstractPlatform $platform, string $attribute): string
            {
                return $platform->getMaxExpression($attribute);

The function Doctrine\DBAL\Platforms\AbstractPlatform::getMaxExpression() has been deprecated: Use MAX() in SQL instead.

            }
        };
    }

    /**
     * Perform AVG() aggregation function
     *
     * @param string $attribute The attribute to aggregate
     *
     * @return self

The doc comment self at position 0 could not be parsed: 'self' is only available from within classes.

     */
    public static function avg(string $attribute): self
    {
        return new class ($attribute) extends Aggregate {
            protected function expression(AbstractPlatform $platform, string $attribute): string
            {
                return $platform->getAvgExpression($attribute);

The function Doctrine\DBAL\Platforms\AbstractPlatform::getAvgExpression() has been deprecated: Use AVG() in SQL instead.

            }
        };
    }

    /**
     * Perform COUNT() aggregation function
     *
     * @param string $attribute The attribute to aggregate
     *
     * @return self

The doc comment self at position 0 could not be parsed: 'self' is only available from within classes.

     */
    public static function count(string $attribute = '*'): self
    {
        return new class ($attribute) extends Aggregate {
            protected function expression(AbstractPlatform $platform, string $attribute): string
            {
                return $platform->getCountExpression($attribute);

The function Doctrine\DBAL\Platforms\AbstractPlatform::getCountExpression() has been deprecated: Use COUNT() in SQL instead.

            }
        };
    }

    /**
     * Perform SUM() aggregation function
     *
     * @param string $attribute The attribute to aggregate
     *
     * @return self

The doc comment self at position 0 could not be parsed: 'self' is only available from within classes.

     */
    public static function sum(string $attribute): self
    {
        return new class ($attribute) extends Aggregate {
            protected function expression(AbstractPlatform $platform, string $attribute): string
            {
                return $platform->getSumExpression($attribute);

The function Doctrine\DBAL\Platforms\AbstractPlatform::getSumExpression() has been deprecated: Use SUM() in SQL instead.

            }
        };
    }
}