Stat Class Reference

Public Member Functions
	start ($timerId, $time, $realMemory, $emallocMemory)
	stop ($timerId, $time, $realMemory, $emallocMemory)
	get ($timerId)
	fetch ($timerId, $key)
	clear ($timerId=null)
	getFilteredTimerIds (array $thresholds=null, $filterPattern=null)

Data Fields
const	ID = 'id'
const	START = 'start'
const	TIME = 'sum'
const	COUNT = 'count'
const	AVG = 'avg'
const	REALMEM = 'realmem'
const	REALMEM_START = 'realmem_start'
const	EMALLOC = 'emalloc'
const	EMALLOC_START = 'emalloc_start'

Protected Member Functions
	_getOrderedTimerIds ()

Protected Attributes
	$_timers = []

Detailed Description

Definition at line 12 of file Stat.php.

Member Function Documentation

_getOrderedTimerIds()

_getOrderedTimerIds ( )

protected

Get ordered list of timer ids

Returns

array

Definition at line 189 of file Stat.php.

    {
        $timerIds = array_keys($this->_timers);
        if (count($timerIds) <= 2) {
            /* No sorting needed */
            return $timerIds;
        }

        /* Prepare PCRE once to use it inside the loop body */
        $nestingSep = preg_quote(Profiler::NESTING_SEPARATOR, '/');
        $patternLastTimerId = '/' . $nestingSep . '(?:.(?!' . $nestingSep . '))+$/';

        $prevTimerId = $timerIds[0];
        $result = [$prevTimerId];
        for ($i = 1; $i < count($timerIds); $i++) {
            $timerId = $timerIds[$i];
            /* Skip already added timer */
            if (!$timerId) {
                continue;
            }
            /* Loop over all timers that need to be closed under previous timer */
            while (strpos($timerId, $prevTimerId . Profiler::NESTING_SEPARATOR) !== 0) {
                /* Add to result all timers nested in the previous timer */
                for ($j = $i + 1; $j < count($timerIds); $j++) {
                    if (strpos($timerIds[$j], $prevTimerId . Profiler::NESTING_SEPARATOR) === 0) {
                        $result[] = $timerIds[$j];
                        /* Mark timer as already added */
                        $timerIds[$j] = null;
                    }
                }
                /* Go to upper level timer */
                $count = 0;
                $prevTimerId = preg_replace($patternLastTimerId, '', $prevTimerId, -1, $count);
                /* Break the loop if no replacements was done. It is possible when we are */
                /* working with top level (root) item */
                if (!$count) {
                    break;
                }
            }
            /* Add current timer to the result */
            $result[] = $timerId;
            $prevTimerId = $timerId;
        }
        return $result;
    }

clear()

clear

(

$timerId = null

)

Clear collected statistics for specified timer or for all timers if timer id is omitted

Parameters

string | null

$timerId

Returns

void

Definition at line 140 of file Stat.php.

    {
        if ($timerId) {
            unset($this->_timers[$timerId]);
        } else {
            $this->_timers = [];
        }
    }

fetch()

fetch	(		$timerId,
			$key
	)

Retrieve statistics on specified timer

Parameters

string	$timerId
string	$key	Information to return

Returns

string|bool|int|float

Exceptions

Definition at line 105 of file Stat.php.

    {
        if ($key === self::ID) {
            return $timerId;
        }
        if (empty($this->_timers[$timerId])) {
            throw new \InvalidArgumentException(sprintf('Timer "%s" doesn\'t exist.', $timerId));
        }
        /* AVG = TIME / COUNT */
        $isAvg = $key == self::AVG;
        if ($isAvg) {
            $key = self::TIME;
        }
        if (!isset($this->_timers[$timerId][$key])) {
            throw new \InvalidArgumentException(sprintf('Timer "%s" doesn\'t have value for "%s".', $timerId, $key));
        }
        $result = $this->_timers[$timerId][$key];
        if ($key == self::TIME && $this->_timers[$timerId][self::START] !== false) {
            $result += microtime(true) - $this->_timers[$timerId][self::START];
        }
        if ($isAvg) {
            $count = $this->_timers[$timerId][self::COUNT];
            if ($count) {
                $result = $result / $count;
            }
        }
        return $result;
    }

get()

get

(

$timerId

)

Get timer statistics data by timer id

Parameters

string

$timerId

Returns

array

Exceptions

Definition at line 89 of file Stat.php.

    {
        if (empty($this->_timers[$timerId])) {
            throw new \InvalidArgumentException(sprintf('Timer "%s" doesn\'t exist.', $timerId));
        }
        return $this->_timers[$timerId];
    }

getFilteredTimerIds()

getFilteredTimerIds	(	array	$thresholds = null,
			$filterPattern = null
	)

Get ordered list of timer ids filtered by thresholds and pcre pattern

Parameters

array | null	$thresholds
string | null	$filterPattern

Returns

array

Definition at line 156 of file Stat.php.

    {
        $timerIds = $this->_getOrderedTimerIds();
        if (!$thresholds && !$filterPattern) {
            return $timerIds;
        }
        $thresholds = (array)$thresholds;
        $result = [];
        foreach ($timerIds as $timerId) {
            /* Filter by pattern */
            if ($filterPattern && !preg_match($filterPattern, $timerId)) {
                continue;
            }
            /* Filter by thresholds */
            $match = true;
            foreach ($thresholds as $fetchKey => $minMatchValue) {
                $match = $this->fetch($timerId, $fetchKey) >= $minMatchValue;
                if ($match) {
                    break;
                }
            }
            if ($match) {
                $result[] = $timerId;
            }
        }
        return $result;
    }

start()

start	(		$timerId,
			$time,
			$realMemory,
			$emallocMemory
	)

Starts timer

Parameters

string	$timerId
int	$time
int	$realMemory	Real size of memory allocated from system
int	$emallocMemory	Memory used by emalloc()

Returns

void

Definition at line 40 of file Stat.php.

    {
        if (empty($this->_timers[$timerId])) {
            $this->_timers[$timerId] = [
                self::START => false,
                self::TIME => 0,
                self::COUNT => 0,
                self::REALMEM => 0,
                self::EMALLOC => 0,
            ];
        }

        $this->_timers[$timerId][self::REALMEM_START] = $realMemory;
        $this->_timers[$timerId][self::EMALLOC_START] = $emallocMemory;
        $this->_timers[$timerId][self::START] = $time;
        $this->_timers[$timerId][self::COUNT]++;
    }

stop()

stop	(		$timerId,
			$time,
			$realMemory,
			$emallocMemory
	)

Stops timer

Parameters

string	$timerId
int	$time
int	$realMemory	Real size of memory allocated from system
int	$emallocMemory	Memory used by emalloc()

Returns

void

Exceptions

Definition at line 68 of file Stat.php.

    {
        if (empty($this->_timers[$timerId])) {
            throw new \InvalidArgumentException(sprintf('Timer "%s" doesn\'t exist.', $timerId));
        }

        $this->_timers[$timerId][self::TIME] += $time - $this->_timers[$timerId]['start'];
        $this->_timers[$timerId][self::START] = false;
        $this->_timers[$timerId][self::REALMEM] += $realMemory;
        $this->_timers[$timerId][self::REALMEM] -= $this->_timers[$timerId][self::REALMEM_START];
        $this->_timers[$timerId][self::EMALLOC] += $emallocMemory;
        $this->_timers[$timerId][self::EMALLOC] -= $this->_timers[$timerId][self::EMALLOC_START];
    }

Field Documentation

$_timers

$_timers = []

protected

#- #-

Definition at line 29 of file Stat.php.

AVG

const AVG = 'avg'

Definition at line 21 of file Stat.php.

COUNT

const COUNT = 'count'

Definition at line 20 of file Stat.php.

EMALLOC

const EMALLOC = 'emalloc'

Definition at line 24 of file Stat.php.

EMALLOC_START

const EMALLOC_START = 'emalloc_start'

Definition at line 25 of file Stat.php.

ID

const ID = 'id'

#+ Timer statistics data keys

Definition at line 17 of file Stat.php.

REALMEM

const REALMEM = 'realmem'

Definition at line 22 of file Stat.php.

REALMEM_START

const REALMEM_START = 'realmem_start'

Definition at line 23 of file Stat.php.

START

const START = 'start'

Definition at line 18 of file Stat.php.

TIME

const TIME = 'sum'

Definition at line 19 of file Stat.php.

---

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

• vendor/magento/framework/Profiler/Driver/Standard/Stat.php