Average

Average calculates the average value of a specified property. It requires that other measures are defined for the sum and count of the property. The average is computed as the sum divided by the count. Average is a virtual measure and does not store its value in the database.

Example

use Doctrine\ORM\Mapping as ORM;
use Doctrine\ORM\Types\Types;
use Rekalogika\Analytics\Core\AggregateFunction\Average;
use Rekalogika\Analytics\Core\AggregateFunction\Count;
use Rekalogika\Analytics\Core\AggregateFunction\Sum;
use Rekalogika\Analytics\Core\Metadata as Analytics;
use Rekalogika\Analytics\Core\Entity\Summary;
use Rekalogika\Analytics\Core\ValueResolver\PropertyValue;

class OrderSummary extends Summary
{
    #[ORM\Column(type: Types::INTEGER)]
    #[Analytics\Measure(
        function: new Sum(new PropertyValue('item.price'),
    )]
    private ?int $price = null;

    #[ORM\Column(type: Types::INTEGER)]
    #[Analytics\Measure(
        function: new Count('id'),
    )]
    private ?int $count = null;

    #[Analytics\Measure(
        function: new Average(
            sumProperty: 'price',
            countProperty: 'count',
        ),
    )]
    private ?int $averageOrderValue = null;
}

In this example, the Average function uses the previously defined price and count measures to compute the average order value. The sumProperty and countProperty parameters specify which properties to use for the sum and count calculations, respectively.

note

It is not necessary to store the average value in the database, and therefore the property does not need the ORM\Column attribute.

Example​

Example