nystudio107\webperf\controllers\TablesController

Complexity

Total Complexity

19

Size/Duplication

Total Lines	172
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	actionDashboard()	0	67	10
B	actionRedirects()	0	62	9

<?php
/**
 * Webperf plugin for Craft CMS 3.x
 *
 * Monitor the performance of your webpages through real-world user timing data
 *
 * @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\webperf\controllers;

use nystudio107\webperf\helpers\Permission as PermissionHelper;

use craft\db\Query;

The type craft\db\Query was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\helpers\UrlHelper;

The type craft\helpers\UrlHelper was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\web\Controller;

The type craft\web\Controller was not found. Maybe you did not declare it correctly or list all dependencies?

use yii\web\ForbiddenHttpException;

The type yii\web\ForbiddenHttpException was not found. Maybe you did not declare it correctly or list all dependencies?

use yii\web\Response;

The type yii\web\Response was not found. Maybe you did not declare it correctly or list all dependencies?

/**

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 indented incorrectly; expected 2 spaces but found 4

 * @package   Webperf

Tag value indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value 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 TablesController extends Controller
{
    // Constants
    // =========================================================================

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

    /**

Missing short description in doc comment

     * @var    bool|array

Tag value indented incorrectly; expected 1 spaces but found 4

     */
    protected $allowAnonymous = [
    ];

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

    /**
     * Handle requests for the dashboard statistics table
     *
     * @param string $sort

Missing parameter comment

     * @param int    $page

Missing parameter comment

     * @param int    $per_page

Missing parameter comment

     * @param string $filter

Missing parameter comment

     * @param null   $siteId

Are you sure the doc-type for parameter $siteId is correct as it would always require null to be passed?

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionDashboard(
        string $sort = 'hitCount|desc',
        int $page = 1,
        int $per_page = 20,
        $filter = '',
        $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf:dashboard');
        $data = [];
        $sortField = 'hitCount';
        $sortType = 'DESC';
        // Figure out the sorting type
        if ($sort !== '') {
            if (strpos($sort, '|') === false) {
                $sortField = $sort;
            } else {
                list($sortField, $sortType) = explode('|', $sort);
            }
        }
        // Query the db table
        $offset = ($page - 1) * $per_page;
        $query = (new Query())
            ->from(['{{%retour_stats}}'])
            ->offset($offset)
            ->limit($per_page)
            ->orderBy("{$sortField} {$sortType}");
        if ((int)$siteId !== 0) {
            $query->where(['siteId' => $siteId]);
        }
        if ($filter !== '') {
            $query->where(['like', 'redirectSrcUrl', $filter]);
            $query->orWhere(['like', 'referrerUrl', $filter]);
        }
        $stats = $query->all();
        if ($stats) {
            // Add in the `addLink` field
            foreach ($stats as &$stat) {
                $stat['addLink'] = '';
                if (!$stat['handledByRetour']) {
                    $encodedUrl = urlencode('/'.ltrim($stat['redirectSrcUrl'], '/'));
                    $stat['addLink'] = UrlHelper::cpUrl('retour/add-redirect', [

The opening parenthesis of a multi-line function call should be the last content on the line.

                        'defaultUrl' => $encodedUrl
                    ]);

For multi-line function calls, the closing parenthesis should be on a new line.

                }
            }
            // Format the data for the API
            $data['data'] = $stats;
            $query = (new Query())
                ->from(['{{%retour_stats}}']);
            if ($filter !== '') {
                $query->where(['like', 'redirectSrcUrl', $filter]);
                $query->orWhere(['like', 'referrerUrl', $filter]);
            }
            $count = $query->count();
            $data['links']['pagination'] = [
                'total' => $count,
                'per_page' => $per_page,
                'current_page' => $page,
                'last_page' => ceil($count / $per_page),
                'next_page_url' => null,
                'prev_page_url' => null,
                'from' => $offset + 1,
                'to' => $offset + ($count > $per_page ? $per_page : $count),
            ];
        }

        return $this->asJson($data);
    }

    /**
     * Handle requests for the dashboard redirects table
     *
     * @param string $sort

Missing parameter comment

     * @param int    $page

Missing parameter comment

     * @param int    $per_page

Missing parameter comment

     * @param string $filter

Missing parameter comment

     * @param null   $siteId

Are you sure the doc-type for parameter $siteId is correct as it would always require null to be passed?

Missing parameter comment

     *
     * @return Response
     * @throws ForbiddenHttpException
     */
    public function actionRedirects(
        string $sort = 'hitCount|desc',
        int $page = 1,
        int $per_page = 20,
        $filter = '',
        $siteId = 0
    ): Response {
        PermissionHelper::controllerPermissionCheck('webperf:redirects');
        $data = [];
        $sortField = 'hitCount';
        $sortType = 'DESC';
        // Figure out the sorting type
        if ($sort !== '') {
            if (strpos($sort, '|') === false) {
                $sortField = $sort;
            } else {
                list($sortField, $sortType) = explode('|', $sort);
            }
        }
        // Query the db table
        $offset = ($page - 1) * $per_page;
        $query = (new Query())
            ->from(['{{%retour_static_redirects}}'])
            ->offset($offset)
            ->limit($per_page)
            ->orderBy("{$sortField} {$sortType}");
        if ((int)$siteId !== 0) {
            $query->where(['siteId' => $siteId]);
        }
        if ($filter !== '') {
            $query->where(['like', 'redirectSrcUrl', $filter]);
            $query->orWhere(['like', 'redirectDestUrl', $filter]);
        }
        $redirects = $query->all();
        // Add in the `deleteLink` field
        foreach ($redirects as &$redirect) {
            $redirect['deleteLink'] = UrlHelper::cpUrl('retour/delete-redirect/'.$redirect['id']);
            $redirect['editLink'] = UrlHelper::cpUrl('retour/edit-redirect/'.$redirect['id']);
        }
        // Format the data for the API
        if ($redirects) {
            $data['data'] = $redirects;
            $query = (new Query())
                ->from(['{{%retour_static_redirects}}']);
            if ($filter !== '') {
                $query->where(['like', 'redirectSrcUrl', $filter]);
                $query->orWhere(['like', 'redirectDestUrl', $filter]);
            }
            $count = $query->count();
            $data['links']['pagination'] = [
                'total' => $count,
                'per_page' => $per_page,
                'current_page' => $page,
                'last_page' => ceil($count / $per_page),
                'next_page_url' => null,
                'prev_page_url' => null,
                'from' => $offset + 1,
                'to' => $offset + ($count > $per_page ? $per_page : $count),
            ];
        }

        return $this->asJson($data);
    }

    // Protected Methods
    // =========================================================================
}