nystudio107\retour\helpers\FileLog

Complexity

Total Complexity

4

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	11	1
A	delete()	0	3	1
A	getContents()	0	5	2

<?php
/**
 * Retour plugin for Craft CMS 3.x
 *
 * 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) 2022 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\helpers;

use Craft;
use craft\helpers\FileHelper;
use craft\log\FileTarget;

/**

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.2.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 FileLog
{
    // Public Static Methods
    // =========================================================================

    /**
     * Create an additional file log target named $filename.log that logs messages
     * in the category $category
     *
     * @param string $fileName

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param string $category

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return void

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public static function create(string $fileName, string $category): void
    {
        // Create a new file target
        $fileTarget = new FileTarget([

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

            'categories' => [$category],
            'levels' => ['error', 'warning', 'info'],
            'logFile' => "@storage/logs/$fileName.log",
            'logVars' => [],
        ]);

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

        // Add the new target file target to the dispatcher
        Craft::getLogger()->dispatcher->targets[] = $fileTarget;
    }

    /**
     * Delete the passed in log file $fileName
     *
     * @param string $fileName

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return void

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public static function delete(string $fileName): void
    {
        FileHelper::unlink(Craft::getAlias("@storage/logs/$fileName.log"));
    }

    /**
     * Get the contents of the log file
     *
     * @param string $fileName

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public static function getContents(string $fileName): string
    {
        $contents = @file_get_contents(Craft::getAlias("@storage/logs/$fileName.log"));

It seems like Craft::getAlias('@storage/logs/'.$fileName.'.log') can also be of type boolean; however, parameter $filename of file_get_contents() does only seem to accept string, maybe add an additional type check?

        return $contents === false ? '' : $contents;
    }
}