MemoryLimit Class Reference

Public Member Functions
	__construct ($memCap, $leakCap, \Magento\TestFramework\Helper\Memory $helper)
	printStats ()
	validateUsage ()

Static Public Member Functions
static	printHeader ()

Detailed Description

Definition at line 10 of file MemoryLimit.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$memCap,
			$leakCap,
		\Magento\TestFramework\Helper\Memory	$helper
	)

Initialize with the values

Parameters

string	$memCap
string	$leakCap
\Magento\TestFramework\Helper\Memory	$helper

Exceptions

Definition at line 35 of file MemoryLimit.php.

    {
        $this->_memCap = $memCap ? $helper->convertToBytes($memCap) : 0;
        $this->_leakCap = $leakCap ? $helper->convertToBytes($leakCap) : 0;
        $this->_helper = $helper;
    }

Member Function Documentation

printHeader()

static printHeader ( )

static

Get a header printout

Returns

string

Definition at line 47 of file MemoryLimit.php.

    {
        return PHP_EOL . '=== Memory Usage System Stats ===' . PHP_EOL;
    }

printStats()

printStats

(

)

Get statistics printout

Returns

string

Definition at line 57 of file MemoryLimit.php.

    {
        list($usage, $leak) = $this->_getUsage();
        $result = [];

        $msg = sprintf(
            "Memory usage (OS):\t%s (%.2F%% of %s reported by PHP",
            $this->_toMb($usage),
            100 * $usage / ($usage - $leak),
            $this->_toMb($usage - $leak)
        );
        $percentMsg = '%.2F%% of configured %s limit';
        if ($this->_memCap) {
            $msg .= ', ' . sprintf($percentMsg, 100 * $usage / $this->_memCap, $this->_toMb($this->_memCap));
        }
        $result[] = "{$msg})";

        $msg = sprintf("Estimated memory leak:\t%s (%.2F%% of used memory", $this->_toMb($leak), 100 * $leak / $usage);
        if ($this->_leakCap) {
            $msg .= ', ' . sprintf($percentMsg, 100 * $leak / $this->_leakCap, $this->_toMb($this->_leakCap));
        }
        $result[] = "{$msg})";

        return implode(PHP_EOL, $result) . PHP_EOL;
    }

validateUsage()

validateUsage

(

)

Raise error if memory usage breaks configured thresholds

Returns

null

Exceptions

Definition at line 100 of file MemoryLimit.php.

    {
        if (!$this->_memCap && !$this->_leakCap) {
            return null;
        }
        list($usage, $leak) = $this->_getUsage();
        if ($this->_memCap && $usage >= $this->_memCap) {
            throw new \LogicException(
                "Memory limit of {$this->_toMb($this->_memCap)} ({$this->_memCap} bytes) has been reached."
            );
        }
        if ($this->_leakCap && $leak >= $this->_leakCap) {
            throw new \LogicException(
                "Estimated memory leak limit of {$this->_toMb(
                    $this->_leakCap
                )}" . " ({$this->_leakCap} bytes) has been reached."
            );
        }
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/integration/framework/Magento/TestFramework/MemoryLimit.php