dukt / analytics

src/controllers/UtilsController.php

<?php
/**
 * @link      https://dukt.net/analytics/
 * @copyright Copyright (c) 2022, Dukt
 * @license   https://github.com/dukt/analytics/blob/master/LICENSE.md
 */

namespace dukt\analytics\controllers;

use Craft;
use craft\helpers\FileHelper;
use craft\web\Controller;
use dukt\analytics\Plugin as Analytics;
use yii\web\Response;

/**
 * Class UtilsController
 *
 * @package dukt\analytics\controllers
 */
class UtilsController extends Controller
{
    // Properties
    // =========================================================================

    /**
     * @var bool
     */
    protected $allowAnonymous = true;

    /**
     * @var int
     */
    private $addedInApiVersion = 3;

    // Public Methods
    // =========================================================================

    /**
     * Metadata.
     *
     * @param string|null $q
     * @param array|null $columns
     * @return Response
     */
    public function actionMetadata(string $q = null, array $columns = null): Response
    {
        $variables['q'] = $q;

$variables was never initialized. Although not strictly required by PHP, it is generally a good practice to add $variables = array(); before regardless.

        $variables['columns'] = $columns;
        $variables['dimensions'] = Analytics::$plugin->metadata->getDimensions();
        $variables['metrics'] = Analytics::$plugin->metadata->getMetrics();

        $variables['dimmetsFileExists'] = Analytics::$plugin->metadata->dimmetsFileExists();

        return $this->renderTemplate('analytics/utils/metadata/_index', $variables);
    }

    /**
     * Searches the meta data.
     *
     * @return null
     */
    public function actionSearchMetadata()
    {
        $q = Craft::$app->getRequest()->getParam('q');
        $columns = Analytics::$plugin->metadata->searchColumns($q);

        // Send the source back to the template
        Craft::$app->getUrlManager()->setRouteParams([
            'q' => $q,
            'columns' => $columns,
        ]);

        return null;
    }

    /**
     * Loads metadata.
     *
     * @return Response
     */
    public function actionLoadMetadata()
    {
        $this->_deleteMetadata();
        $this->_importMetadata();

        Craft::$app->getSession()->setNotice(Craft::t('analytics', 'Metadata loaded.'));

        $referrer = Craft::$app->getRequest()->referrer;

        return $this->redirect($referrer);
    }

    // Private Methods
    // =========================================================================


    /**
     * Deletes metadata.
     */
    private function _deleteMetadata()
    {
        $path = Analytics::$plugin->metadata->getDimmetsFilePath();

        FileHelper::removeFile($path);

The function craft\helpers\FileHelper::removeFile() has been deprecated: in 3.0.0-RC11. Use [[unlink()]] instead.

It seems like $path can also be of type false; however, parameter $path of craft\helpers\FileHelper::removeFile() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * Imports metadata.
     */
    private function _importMetadata()
    {
        $columns = [];

        $items = Analytics::$plugin->getApis()->getAnalytics()->getColumns();

        if ($items) {

$items is of type Google_Service_Analytics_Columns, thus it always evaluated to true.

            foreach ($items as $item) {
                if ($item->attributes['status'] == 'DEPRECATED') {
                    continue;
                }

                if ($item->attributes['addedInApiVersion'] > $this->addedInApiVersion) {
                    continue;
                }

                $this->addColumnFromItem($columns, $item);
            }
        }

        $contents = json_encode($columns, JSON_PRETTY_PRINT);

        $path = Analytics::$plugin->metadata->getDimmetsFilePath();

        FileHelper::writeToFile($path, $contents);

It seems like $path can also be of type false; however, parameter $file of craft\helpers\FileHelper::writeToFile() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * Add column from item.
     *
     * @param $columns
     * @param $item
     */
    private function addColumnFromItem(&$columns, $item)
    {
        if (isset($item->attributes['minTemplateIndex'])) {
            for ($i = $item->attributes['minTemplateIndex']; $i <= $item->attributes['maxTemplateIndex']; $i++) {
                $column = [];
                $column['id'] = str_replace('XX', $i, $item->id);
                $column['uiName'] = str_replace('XX', $i, $item->attributes['uiName']);
                $column['description'] = str_replace('XX', $i, $item->attributes['description']);

                $columns[$column['id']] = $this->populateColumnAttributes($column, $item);
            }
        } else {
            $column = [];
            $column['id'] = $item->id;
            $column['uiName'] = $item->attributes['uiName'];
            $column['description'] = $item->attributes['description'];

            $columns[$column['id']] = $this->populateColumnAttributes($column, $item);
        }
    }

    /**
     * Populates the coloumn attribute.
     *
     * @param $column
     * @param $item
     *
     * @return mixed
     */
    private function populateColumnAttributes($column, $item)
    {
        $column['type'] = $item->attributes['type'];
        $column['dataType'] = $item->attributes['dataType'];
        $column['group'] = $item->attributes['group'];
        $column['status'] = $item->attributes['status'];

        if (isset($item->attributes['allowInSegments'])) {
            $column['allowInSegments'] = $item->attributes['allowInSegments'];
        }

        if (isset($item->attributes['addedInApiVersion'])) {
            $column['addedInApiVersion'] = $item->attributes['addedInApiVersion'];
        }

        return $column;
    }
}