nystudio107\webperf\recommendations\MemoryLimit

Complexity

Total Complexity

9

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	evaluate()	0	57	5
A	memoryLimit()	0	12	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\recommendations;

use nystudio107\webperf\base\Recommendation;

use Craft;

The type Craft 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 MemoryLimit extends Recommendation
{
    // Constants
    // =========================================================================

    const MIN_CRAFT_MEMORY = 64 * 1024 * 1024;
    const MAX_CRAFT_MEMORY = 1024 * 1024 * 1024;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function evaluate()
    {
        $phpMemoryLimit = $this->memoryLimit();
        if ($phpMemoryLimit) {
            $ratio = $phpMemoryLimit / $this->sample->craftTotalMemory;
            $displayCraftTotalMemory = (($this->sample->craftTotalMemory / 1024) / 1024) . 'M';
            $displayPhpMemoryLimit = (($phpMemoryLimit / 1024) / 1024) . 'M';
            $displayCraftMinMemory = ((self::MIN_CRAFT_MEMORY / 1024) / 1024) . 'M';
            $displayCraftMaxMemory = ((self::MAX_CRAFT_MEMORY / 1024) / 1024) . 'M';

The assignment to $displayCraftMaxMemory is dead and can be removed.

            $this->summary = Craft::t(
                'webperf',
                'Check the `memory_limit` setting in your `php.ini` file',
                []
            );
            // See if they have enough memory allocated
            if ($phpMemoryLimit < self::MIN_CRAFT_MEMORY) {
                $this->hasRecommendation = true;
                $this->detail = Craft::t(
                    'webperf',
                    'Pixel & Tonic recommends at least {displayCraftMinMemory} allocated to PHP for Craft CMS 3. You have only {displayPhpMemoryLimit} allocated in your `php.ini` file.',
                    [
                        'displayPhpMemoryLimit' => $displayPhpMemoryLimit,
                        'displayCraftMinMemory' => $displayCraftMinMemory,
                    ]
                );
                $this->learnMoreUrl = 'https://docs.craftcms.com/v3/requirements.html';

                return;
            }
            // See if they have too much memory allocated
            if ($phpMemoryLimit >= self::MAX_CRAFT_MEMORY) {
                $this->hasRecommendation = true;
                $this->detail = Craft::t(
                    'webperf',
                    'Your `php.ini` file has `memory_limit` set to {displayPhpMemoryLimit}. This may be set too high, since it is a per-process memory limit, and memory-intensive image transforms are done in a process separate from PHP.',
                    [
                        'displayPhpMemoryLimit' => $displayPhpMemoryLimit,
                    ]
                );
                $this->learnMoreUrl = 'https://docs.craftcms.com/v3/requirements.html';

                return;
            }
            // See if they have too much memory allocated
            if ($ratio < 1.5) {
                $this->hasRecommendation = true;
                $this->detail = Craft::t(
                    'webperf',
                    'Your `php.ini` file has `memory_limit` set to {displayPhpMemoryLimit}, but Craft is using {displayCraftTotalMemory}. Consider raising your `memory_limit`  to maintain a `1.5x` buffer of available memory.',
                    [
                        'displayPhpMemoryLimit' => $displayPhpMemoryLimit,
                        'displayCraftTotalMemory' => $displayCraftTotalMemory,
                    ]
                );
                $this->learnMoreUrl = 'https://docs.craftcms.com/v3/requirements.html';

                return;
            }
        }
    }

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

    /**

Missing short description in doc comment

     * @return int
     */
    protected function memoryLimit(): int
    {
        $memoryLimit = ini_get('memory_limit');
        if (preg_match('/^(\d+)(.)$/', $memoryLimit, $matches)) {
            if (strtoupper($matches[2]) === 'M') {
                $memoryLimit = $matches[1] * 1024 * 1024; // nnnM -> nnn MB
            } elseif (strtoupper($matches[2]) === 'K') {
                $memoryLimit = $matches[1] * 1024; // nnnK -> nnn KB
            }
        }

        return $memoryLimit;

The expression return $memoryLimit could return the type string which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }
}