# metricool/2.1.1/app/Services/AnalyticsService.php

Metricool – Social media and site statistics, version 2.1.1. 143 lines.

- Page: https://pluginprobe.com/plugins/metricool/2.1.1/code/app/Services/AnalyticsService.php
- Raw: https://pluginprobe.com/plugins/metricool/2.1.1/raw/app/Services/AnalyticsService.php
- Modified: 2026-08-20T14:08:30+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/metricool/2.1.1/code/app/Services/AnalyticsService.php#L10-L20`.

```php
<?php

declare(strict_types=1);

namespace Metricool\Services;

use InvalidArgumentException;
use Metricool\Http\Metricool\Filters\PeriodFilter;
use Metricool\Support\Builders\StatsTimelineBuilder;
use Metricool\Support\Helpers\Collection;
use Metricool\Http\Metricool\DTOs\TimelineDTO;
use Metricool\Http\Metricool\Entities\TimelineStatistics;
use Metricool\Services\Analytics\TrendService;

class AnalyticsService
{
    protected TrendService $trendService;

    protected array $requestFilters = [];
    /**
     * Metrics holds the name of the Metric, TimelineStatistics and results of the API request
     * @var array<string, array{
     *     name: string,
     *     label: string,
     *     statistics: TimelineStatistics,
     *     results: Collection|TimelineDTO[],
     *     useInTimeline: bool,
     *  }>
     **/
    protected array $metrics = [];

    public function __construct(TrendService $trendService)
    {
        $this->trendService = $trendService;
    }

    /**
     * Sets the request filters to be used in the analytics service. These
     * filters are used to filter the results of the metrics when fetching data
     * from the API: {@see TimelineStatistics::filter()} in {@see loadMetric()}
     */
    public function setRequestFilters(array $requestFilters): self
    {
        $this->requestFilters = $requestFilters;
        return $this;
    }

    /**
     * Sets the metrics to be used in the analytics service
     * This will fetch the results from the API and store them
     */
    public function loadMetric(string $metric, string $label, TimelineStatistics $statistics): self
    {
        $this->metrics[$metric] = [
            'name' => $metric,
            'label' => $label,
            'statistics' => $statistics,
            'results' => $statistics->filter($this->requestFilters)->get(),
        ];

        return $this;
    }

    /**
     * Gets the totals of all loaded metrics
     */
    public function getTotals(): array
    {
        $totals = [];
        foreach ($this->metrics as $metric => $metricData) {
            $totals[$metric] = [
                'label' => $metricData['label'],
                'totalAmount' => $this->calcTotalAmount($metric),
                'trend' => $this->getTrend($metric),
            ];
        }
        return $totals;
    }

    /**
     * Gets the results of a metric
     * @return Collection<int, TimelineDTO>
     * @throws InvalidArgumentException
     */
    public function getResults(string $metric): Collection
    {
        if (array_key_exists($metric, $this->metrics) === false) {
            throw new InvalidArgumentException(esc_html("Incompatible metric given: $metric"));
        }

        return $this->metrics[$metric]['results'];
    }

    /**
     * Gets the TimelineStatistics Entity of a metric
     * @throws InvalidArgumentException
     */
    public function getTimelineStatistics(string $metric): TimelineStatistics
    {
        if (array_key_exists($metric, $this->metrics) === false) {
            throw new InvalidArgumentException(esc_html("Incompatible metric given: $metric"));
        }

        return $this->metrics[$metric]['statistics'];
    }

    /**
     * Sums the amount of hits of this metric
     */
    public function calcTotalAmount(string $metric): float
    {
        return $this->getResults($metric)->sum('amount');
    }

    /**
     * Returns the trend on the previous period
     */
    public function getTrend(string $metric): string
    {
        return $this->trendService->getTrend(
            $this->getTimelineStatistics($metric),
            $this->getResults($metric),
        );
    }

    /**
     * Builds the timeline
     * @see \Metricool\Http\Endpoints\AnalyticsEndpoint
     */
    public function getTimelineData(): array
    {
        $builder = new StatsTimelineBuilder();

        if (!empty($this->requestFilters['period'])) {
            $builder->setDateFormat(
                PeriodFilter::getIsoDateMonthFormat($this->requestFilters['period'])
            );
        }

        return $builder->setMetrics($this->metrics)->build();
    }
}

```