nystudio107 / craft-retour

src/controllers/StatisticsController.php

<?php
/**
 * Retour plugin for Craft CMS
 *
 * Retour allows you to intelligently redirect legacy URLs, so that you don't
 * lose SEO value when rebuilding & restructuring a website
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\retour\controllers;

use Craft;
use craft\errors\MissingComponentException;
use craft\helpers\UrlHelper;
use craft\web\Controller;

use nystudio107\retour\assetbundles\retour\RetourDashboardAsset;
use nystudio107\retour\helpers\MultiSite as MultiSiteHelper;
use nystudio107\retour\helpers\Permission as PermissionHelper;
use nystudio107\retour\Retour;

use yii\base\InvalidConfigException;
use yii\web\NotFoundHttpException;
use yii\web\Response;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Retour

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     3.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class StatisticsController extends Controller
{
    // Constants
    // =========================================================================

    const DOCUMENTATION_URL = 'https://github.com/nystudio107/craft-retour/';

    // Protected Properties
    // =========================================================================

    protected $allowAnonymous = [];

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


    /**

Missing short description in doc comment

     * @param string|null $siteHandle

Missing parameter comment

     * @param bool $showWelcome

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionDashboard(string $siteHandle = null, bool $showWelcome = false): Response
    {
        $variables = [];
        PermissionHelper::controllerPermissionCheck('retour:dashboard');
        // Trim the statistics
        Retour::$plugin->statistics->trimStatistics();
        // Get the site to edit
        $siteId = MultiSiteHelper::getSiteIdFromHandle($siteHandle);
        $pluginName = Retour::$settings->pluginName;
        $templateTitle = Craft::t('retour', 'Dashboard');
        $view = Craft::$app->getView();
        // Asset bundle
        try {
            $view->registerAssetBundle(RetourDashboardAsset::class);
        } catch (InvalidConfigException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        $variables['baseAssetsUrl'] = Craft::$app->assetManager->getPublishedUrl(
            '@nystudio107/retour/web/assets/dist',
            true

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

        );
        // Enabled sites
        MultiSiteHelper::setMultiSiteVariables($siteHandle, $siteId, $variables);
        $variables['controllerHandle'] = 'dashboard';

        // Basic variables
        $variables['fullPageForm'] = false;
        $variables['docsUrl'] = self::DOCUMENTATION_URL;
        $variables['pluginName'] = $pluginName;
        $variables['title'] = $templateTitle;
        $siteHandleUri = Craft::$app->isMultiSite ? '/' . $siteHandle : '';
        $variables['crumbs'] = [
            [
                'label' => $pluginName,
                'url' => UrlHelper::cpUrl('retour'),
            ],
            [
                'label' => $templateTitle,
                'url' => UrlHelper::cpUrl('retour/dashboard' . $siteHandleUri),
            ],
        ];
        $variables['docTitle'] = "{$pluginName} - {$templateTitle}";
        $variables['selectedSubnavItem'] = 'dashboard';
        $variables['showWelcome'] = $showWelcome;
        $variables['settings'] = Retour::$settings;

        // Render the template
        return $this->renderTemplate('retour/dashboard/index', $variables);
    }

    /**

Missing short description in doc comment

     * @return Response
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionClearStatistics(): Response
    {
        PermissionHelper::controllerPermissionCheck('retour:dashboard');
        $error = Retour::$plugin->statistics->clearStatistics();
        Craft::info(
            Craft::t(
                'retour',
                'Retour statistics cleared: {error}',
                ['error' => $error]
            ),
            __METHOD__
        );
        Retour::$plugin->clearAllCaches();
        try {
            Craft::$app->getSession()->setNotice(Craft::t('retour', 'Retour statistics cleared.'));
        } catch (MissingComponentException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return $this->redirect('retour/dashboard');
    }

    /**

Missing short description in doc comment

     * @return Response|void
     * @throws MissingComponentException
     * @throws \yii\web\BadRequestHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionDeleteStatistics()
    {
        PermissionHelper::controllerPermissionCheck('retour:dashboard');
        $request = Craft::$app->getRequest();
        $statisticIds = $request->getRequiredBodyParam('statisticIds');
        $stickyError = false;
        foreach ($statisticIds as $statisticId) {
            if (Retour::$plugin->statistics->deleteStatisticById($statisticId) === 0) {
                $stickyError = true;
            }
        }
        Craft::info(
            Craft::t(
                'retour',
                'Retour statistics deleted: {error}',
                ['error' => $stickyError]
            ),
            __METHOD__
        );

        Retour::$plugin->clearAllCaches();
        // Handle any cumulative errors
        if (!$stickyError) {
            // Clear the caches and continue on
            Craft::$app->getSession()->setNotice(Craft::t('retour', 'Retour statistics deleted.'));

            return $this->redirect('retour/dashboard');
        }
        Craft::$app->getSession()->setError(Craft::t('retour', "Couldn't delete statistic."));

        return;
    }
}