Profiler Class Reference

Static Public Member Functions
static	setDefaultTags (array $tags)
static	addTagFilter ($tagName, $tagValue)
static	add (DriverInterface $driver)
static	enable ()
static	disable ()
static	isEnabled ()
static	reset ()
static	applyConfig ($config, $baseDir, $isAjax=false)

Data Fields
const	NESTING_SEPARATOR = '->'

Static Protected Member Functions
static	_parseConfig ($profilerConfig, $baseDir, $isAjax)
static	_parseDriverConfigs (array $driverConfigs, $baseDir)
static	_parseDriverConfig ($driverConfig)

Detailed Description

@api

Since

100.0.2

Definition at line 17 of file Profiler.php.

Member Function Documentation

_parseConfig()

static _parseConfig (   $profilerConfig,   $baseDir,   $isAjax  )

staticprotected

Parses config

Parameters

array | string	$profilerConfig
string	$baseDir
bool	$isAjax

Returns

array @SuppressWarnings(PHPMD.NPathComplexity) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 355 of file Profiler.php.

    {
        $config = ['baseDir' => $baseDir, 'tagFilters' => []];

        if (is_scalar($profilerConfig)) {
            $config['drivers'] = [
                ['output' => is_numeric($profilerConfig) ? 'html' : $profilerConfig],
            ];
        } else {
            $config = array_merge($config, $profilerConfig);
        }

        $driverConfigs = (array)(isset($config['drivers']) ? $config['drivers'] : []);
        $driverFactory = isset($config['driverFactory']) ? $config['driverFactory'] : new Factory();
        $tagFilters = (array)(isset($config['tagFilters']) ? $config['tagFilters'] : []);

        $result = [
            'driverConfigs' => self::_parseDriverConfigs($driverConfigs, $config['baseDir']),
            'driverFactory' => $driverFactory,
            'tagFilters' => $tagFilters,
            'baseDir' => $config['baseDir'],
        ];
        return $result;
    }

_parseDriverConfig()

static _parseDriverConfig (   $driverConfig )

staticprotected

Parses driver config

Parameters

mixed

$driverConfig

Returns

array|false

Definition at line 412 of file Profiler.php.

    {
        $result = false;
        if (is_array($driverConfig)) {
            $result = $driverConfig;
        } elseif (is_scalar($driverConfig) && $driverConfig) {
            if (is_numeric($driverConfig)) {
                $result = [];
            } else {
                $result = ['type' => $driverConfig];
            }
        }
        return $result;
    }

_parseDriverConfigs()

static _parseDriverConfigs ( array  $driverConfigs,   $baseDir  )

staticprotected

Parses list of driver configurations

Parameters

array	$driverConfigs
string	$baseDir

Returns

array

Definition at line 387 of file Profiler.php.

    {
        $result = [];
        foreach ($driverConfigs as $code => $driverConfig) {
            $driverConfig = self::_parseDriverConfig($driverConfig);
            if ($driverConfig === false) {
                continue;
            }
            if (!isset($driverConfig['type']) && !is_numeric($code)) {
                $driverConfig['type'] = $code;
            }
            if (!isset($driverConfig['baseDir']) && $baseDir) {
                $driverConfig['baseDir'] = $baseDir;
            }
            $result[] = $driverConfig;
        }
        return $result;
    }

add()

static add ( DriverInterface  $driver )

static

Add profiler driver.

Parameters

DriverInterface

$driver

Returns

void

Definition at line 137 of file Profiler.php.

    {
        self::$_drivers[] = $driver;
        self::enable();
    }

addTagFilter()

static addTagFilter (   $tagName,   $tagValue  )

static

Add tag filter.

Parameters

string	$tagName
string	$tagValue

Returns

void

Definition at line 98 of file Profiler.php.

    {
        if (!isset(self::$_tagFilters[$tagName])) {
            self::$_tagFilters[$tagName] = [];
        }
        self::$_tagFilters[$tagName][] = $tagValue;
        self::$_hasTagFilters = true;
    }

applyConfig()

static applyConfig (   $config,   $baseDir,   $isAjax = false  )

static

Init profiler

Parameters

array | string	$config
string	$baseDir
bool	$isAjax

Returns

void

Definition at line 332 of file Profiler.php.

    {
        $config = self::_parseConfig($config, $baseDir, $isAjax);
        if ($config['driverConfigs']) {
            foreach ($config['driverConfigs'] as $driverConfig) {
                self::add($config['driverFactory']->create($driverConfig));
            }
        }
        foreach ($config['tagFilters'] as $tagName => $tagValue) {
            self::addTagFilter($tagName, $tagValue);
        }
    }

disable()

static disable ( )

static

Disable profiling.

Any call to profiler is silently ignored while profiler is disabled.

Returns

void

Definition at line 194 of file Profiler.php.

    {
        self::$_enabled = false;
    }

enable()

static enable ( )

static

Enable profiling.

Any call to profiler does nothing until profiler is enabled.

Returns

void

Definition at line 182 of file Profiler.php.

    {
        self::$_enabled = true;
    }

isEnabled()

static isEnabled ( )

static

Get profiler enable status.

Returns

bool

Definition at line 204 of file Profiler.php.

    {
        return self::$_enabled;
    }

reset()

static reset ( )

static

Reset profiler to initial state

Returns

void

Definition at line 233 of file Profiler.php.

    {
        self::clear();
        self::$_enabled = false;
        self::$_currentPath = [];
        self::$_tagFilters = [];
        self::$_defaultTags = [];
        self::$_hasTagFilters = false;
        self::$_drivers = [];
        self::$_pathCount = 0;
        self::$_pathIndex = [];
    }

setDefaultTags()

static setDefaultTags ( array  $tags )

static

Set default tags

Parameters

array

$tags

Returns

void

Definition at line 86 of file Profiler.php.

    {
        self::$_defaultTags = $tags;
    }

Field Documentation

NESTING_SEPARATOR

const NESTING_SEPARATOR = '->'

Separator literal to assemble timer identifier from timer names

Definition at line 22 of file Profiler.php.

---

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

• vendor/magento/framework/Profiler.php