nystudio107\webperf\controllers\FileController

Complexity

Total Complexity

8

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	actionExportErrorSamples()	0	13	2
A	actionExportDataSamples()	0	13	2
A	exportCsvFile()	0	35	4

<?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) 2019 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;

The type Craft was not found. Maybe you did not declare it correctly or list all dependencies?

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\web\Controller;

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

use League\Csv\CannotInsertRecord;

The type League\Csv\CannotInsertRecord was not found. Maybe you did not declare it correctly or list all dependencies?

use League\Csv\Writer;

The type League\Csv\Writer 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 FileController extends Controller
{
    // Constants
    // =========================================================================

    const EXPORT_DATA_SAMPLES_COLUMNS = [
        'siteId',
        'title',
        'url',
        'queryString',
        'dns',
        'connect',
        'firstByte',
        'firstPaint',
        'firstContentfulPaint',
        'domInteractive',
        'pageLoad',
        'countryCode',
        'device',
        'browser',
        'os',
        'mobile',
        'craftTotalMs',
        'craftDbMs',
        'craftDbCnt',
        'craftTwigMs',
        'craftTwigCnt',
        'craftOtherMs',
        'craftOtherCnt',
        'craftTotalMemory',
    ];

    const EXPORT_ERROR_SAMPLES_COLUMNS = [
        'siteId',
        'title',
        'url',
        'queryString',
        'type',
        'pageErrors',
    ];

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

    protected $allowAnonymous = [];

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

    /**
     * Export the data samples table as a CSV file
     *
     * @param string   $pageUrl

Missing parameter comment

     * @param int|null $siteId

Missing parameter comment

     *
     * @throws \yii\web\ForbiddenHttpException
     */

Missing @return tag in function comment

    public function actionExportDataSamples(string $pageUrl = '', int $siteId = null)
    {
        PermissionHelper::controllerPermissionCheck('webperf:performance');
        try {
            $this->exportCsvFile(
                'webperf-data-samples',
                '{{%webperf_data_samples}}',
                self::EXPORT_DATA_SAMPLES_COLUMNS,
                $pageUrl,
                $siteId
            );
        } catch (CannotInsertRecord $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
    }

    /**
     * Export the error samples table as a CSV file
     *
     * @param string   $pageUrl

Missing parameter comment

     * @param int|null $siteId

Missing parameter comment

     *
     * @throws \yii\web\ForbiddenHttpException
     */

Missing @return tag in function comment

    public function actionExportErrorSamples(string $pageUrl = '', int $siteId = null)
    {
        PermissionHelper::controllerPermissionCheck('webperf:errors');
        try {
            $this->exportCsvFile(
                'webperf-error-samples',
                '{{%webperf_error_samples}}',
                self::EXPORT_ERROR_SAMPLES_COLUMNS,
                $pageUrl,
                $siteId
            );
        } catch (CannotInsertRecord $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
    }

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

    /**

Missing short description in doc comment

     * @param string   $filename

Missing parameter comment

     * @param string   $table

Missing parameter comment

     * @param array    $columns

Missing parameter comment

     * @param string   $pageUrl

Missing parameter comment

     * @param int|null $siteId

Missing parameter comment

     *
     * @throws \League\Csv\CannotInsertRecord
     */

Missing @return tag in function comment

    protected function exportCsvFile(
        string $filename,
        string $table,
        array $columns,
        string $pageUrl = '',
        int $siteId = null
    ) {
        // If your CSV document was created or is read on a Macintosh computer,
        // add the following lines before using the library to help PHP detect line ending in Mac OS X
        if (!ini_get('auto_detect_line_endings')) {
            ini_set('auto_detect_line_endings', '1');
        }
        // Query the db table
        $query = (new Query())
            ->from([$table])
            ->select($columns)

Space after closing parenthesis of function call prohibited

            ;
        if ($siteId !== null) {
            $query
                ->where(['siteId' => $siteId])

Space after closing parenthesis of function call prohibited

            ;
        }
        if (!empty($pageUrl)) {
            $query
                ->where(['pageUrl' => $pageUrl])

Space after closing parenthesis of function call prohibited

            ;
        }
        $data = $query
            ->all();
        // Create our CSV file writer
        $csv = Writer::createFromFileObject(new \SplTempFileObject());
        $csv->insertOne($columns);
        $csv->insertAll($data);
        $csv->output($filename.'.csv');
        exit(0);

Using exit here is not recommended.

    }
}