Bdf\Prime\Query\Expression\Aggregate

Complexity

Total Complexity

2

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
	max()	0	6	?
	sum()	0	6	?
A	hp$0 ➔ expression()	0	3	1
A	hp$4 ➔ expression()	0	3	1
	avg()	0	6	?
	min()	0	6	?
A	hp$1 ➔ max()	0	6	1
A	hp$3 ➔ count()	0	6	1
A	hp$3 ➔ expression()	0	3	1
	count()	0	6	?
A	hp$2 ➔ avg()	0	6	1
A	hp$1 ➔ expression()	0	3	1
A	build()	0	5	1
A	hp$2 ➔ expression()	0	3	1
A	hp$4 ➔ sum()	0	6	1
A	__construct()	0	3	1
A	hp$0 ➔ min()	0	6	1

<?php

namespace Bdf\Prime\Query\Expression;

use Doctrine\DBAL\Platforms\AbstractPlatform;

/**
 * Aggregation expressions
 * Can be use on Query::select() method

Doc comment short description must be on a single line, further text should be a separate paragraph

 *
 * Usage:
 * <code>
 * User::select([
 *     'firstId' => Aggregate::min(id),
 *     'lastId' => Aggregate::max(id),
 *     'count' => Aggregate::count(id),
 * ]);
 * </code>
 */
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;
    }

    /**

Parameter $query should have a doc-comment as per coding-style.

Parameter $compiler should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */
    final public function build($query, $compiler)
    {
        return $this->expression(
            $compiler->platform()->grammar(),
            $compiler->quoteIdentifier($query, $query->preprocessor()->field($this->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

Expected 1 blank line before function; 0 found

Missing doc comment for function expression()

Missing function doc comment

            {
                return $platform->getMinExpression($attribute);
            }
        };
    }

    /**
     * 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

Expected 1 blank line before function; 0 found

Missing doc comment for function expression()

Missing function doc comment

            {
                return $platform->getMaxExpression($attribute);
            }
        };
    }

    /**
     * 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

Expected 1 blank line before function; 0 found

Missing doc comment for function expression()

Missing function doc comment

            {
                return $platform->getAvgExpression($attribute);
            }
        };
    }

    /**
     * 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

Expected 1 blank line before function; 0 found

Missing doc comment for function expression()

Missing function doc comment

            {
                return $platform->getCountExpression($attribute);
            }
        };
    }

    /**
     * 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

Expected 1 blank line before function; 0 found

Missing doc comment for function expression()

Missing function doc comment

            {
                return $platform->getSumExpression($attribute);
            }
        };
    }
}