HOME

<?php
/**
 * @file components/PKPStatsComponent.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class PKPStatsComponent
 *
 * @ingroup classes_components_stats
 *
 * @brief A class to prepare the data object for a statistics UI component
 */

namespace PKP\components;

use PKP\statistics\PKPStatisticsHelper;

class PKPStatsComponent
{
    /** @var string The URL to the /stats API endpoint */
    public $apiUrl = '';

    /** @var array Configuration for the columns to display in the table */
    public $tableColumns = [];

    /** @var string Retrieve stats after this date */
    public $dateStart = '';

    /** @var string Retrieve stats before this date */
    public $dateEnd = '';

    /** @var array Quick options to provide for configuring the date range */
    public $dateRangeOptions = [];

    /** @var array|null Configuration assoc array for available filters */
    public $filters = null;

    /**
     * Constructor
     *
     * @param string $apiUrl The URL to fetch stats from
     * @param array $args Optional arguments
     */
    public function __construct($apiUrl, $args = [])
    {
        $this->apiUrl = $apiUrl;
        $this->init($args);
    }

    /**
     * Initialize the handler with config parameters
     *
     * @param array $args Configuration params
     */
    public function init($args = [])
    {
        foreach ($args as $key => $value) {
            if (property_exists($this, $key)) {
                $this->{$key} = $value;
            }
        }
    }

    /**
     * Retrieve the configuration data to be used when initializing this
     * handler on the frontend
     *
     * @return array Configuration data
     */
    public function getConfig()
    {
        $config = [
            'apiUrl' => $this->apiUrl,
            'tableColumns' => $this->tableColumns,
            'dateStart' => $this->dateStart,
            'dateStartMin' => PKPStatisticsHelper::STATISTICS_EARLIEST_DATE,
            'dateEnd' => $this->dateEnd,
            'dateEndMax' => date('Y-m-d', strtotime('yesterday')),
            'dateRangeOptions' => $this->dateRangeOptions,
            'activeFilters' => [],
            'isLoadingItems' => false,
            'isSidebarVisible' => false,
        ];

        if ($this->filters) {
            $config['filters'] = $this->filters;
        }

        return $config;
    }
}