Profiler Class Reference

Inheritance diagram for Profiler:

Public Member Functions
	__construct (\Magento\Framework\Cache\FrontendInterface $frontend, $backendPrefixes=[])
	test ($identifier)
	load ($identifier)
	save ($data, $identifier, array $tags=[], $lifeTime=null)
	remove ($identifier)
	clean ($mode=\Zend_Cache::CLEANING_MODE_ALL, array $tags=[])
Public Member Functions inherited from Bare
	__construct (\Magento\Framework\Cache\FrontendInterface $frontend)
	test ($identifier)
	load ($identifier)
	save ($data, $identifier, array $tags=[], $lifeTime=null)
	remove ($identifier)
	clean ($mode=\Zend_Cache::CLEANING_MODE_ALL, array $tags=[])
	getBackend ()
	getLowLevelFrontend ()

Protected Member Functions
	_getProfilerTags ($operation)
	_getBackendType ()
Protected Member Functions inherited from Bare
	setFrontend (\Magento\Framework\Cache\FrontendInterface $frontend)
	_getFrontend ()

Detailed Description

Cache frontend decorator that performs profiling of cache operations

Definition at line 12 of file Profiler.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Cache\FrontendInterface	$frontend,
			$backendPrefixes = []
	)

Parameters

\Magento\Framework\Cache\FrontendInterface	$frontend
	string[]	$backendPrefixes Backend class prefixes to be striped for profiling informativeness

Definition at line 25 of file Profiler.php.

    {
        parent::__construct($frontend);
        $this->_backendPrefixes = $backendPrefixes;
    }

Member Function Documentation

_getBackendType()

_getBackendType ( )

protected

Get short cache backend type name by striping known backend class prefixes

Returns

string

Definition at line 52 of file Profiler.php.

    {
        $result = get_class($this->getBackend());
        foreach ($this->_backendPrefixes as $backendClassPrefix) {
            if (substr($result, 0, strlen($backendClassPrefix)) == $backendClassPrefix) {
                $result = substr($result, strlen($backendClassPrefix));
                break;
            }
        }
        return $result;
    }

_getProfilerTags()

_getProfilerTags (   $operation )

protected

Retrieve profiler tags that correspond to a cache operation

Parameters

string

$operation

Returns

array

Definition at line 37 of file Profiler.php.

    {
        return [
            'group' => 'cache',
            'operation' => 'cache:' . $operation,
            'frontend_type' => get_class($this->getLowLevelFrontend()),
            'backend_type' => $this->_getBackendType()
        ];
    }

clean()

clean	(		$mode = \Zend_Cache::CLEANING_MODE_ALL,
		array	$tags = []
	)

{Clean cache records matching specified tags

Parameters

string	$mode
array	$tags

Returns

bool @api

}

Implements FrontendInterface.

Definition at line 113 of file Profiler.php.

    {
        \Magento\Framework\Profiler::start('cache_clean', $this->_getProfilerTags('clean'));
        $result = parent::clean($mode, $tags);
        \Magento\Framework\Profiler::stop('cache_clean');
        return $result;
    }

load()

load

(

$identifier

)

{Load cache record by its unique identifier

Parameters

string

$identifier

Returns

string|bool @api

}

Implements FrontendInterface.

Definition at line 78 of file Profiler.php.

    {
        \Magento\Framework\Profiler::start('cache_load', $this->_getProfilerTags('load'));
        $result = parent::load($identifier);
        \Magento\Framework\Profiler::stop('cache_load');
        return $result;
    }

remove()

remove

(

$identifier

)

{Remove cache record by its unique identifier

Parameters

string

$identifier

Returns

bool @api

}

Implements FrontendInterface.

Definition at line 102 of file Profiler.php.

    {
        \Magento\Framework\Profiler::start('cache_remove', $this->_getProfilerTags('remove'));
        $result = parent::remove($identifier);
        \Magento\Framework\Profiler::stop('cache_remove');
        return $result;
    }

save()

save	(		$data,
			$identifier,
		array	$tags = [],
			$lifeTime = null
	)

Enforce marking with a tag

{Save cache record

Parameters

string	$data
string	$identifier
array	$tags
int | bool | null	$lifeTime

Returns

bool @api

}

Implements FrontendInterface.

Definition at line 91 of file Profiler.php.

    {
        \Magento\Framework\Profiler::start('cache_save', $this->_getProfilerTags('save'));
        $result = parent::save($data, $identifier, $tags, $lifeTime);
        \Magento\Framework\Profiler::stop('cache_save');
        return $result;
    }

test()

test

(

$identifier

)

{Test if a cache is available for the given id

Parameters

string

$identifier

Cache id

Returns

int|bool Last modified time of cache entry if it is available, false otherwise

}

Implements FrontendInterface.

Definition at line 67 of file Profiler.php.

    {
        \Magento\Framework\Profiler::start('cache_test', $this->_getProfilerTags('test'));
        $result = parent::test($identifier);
        \Magento\Framework\Profiler::stop('cache_test');
        return $result;
    }

---

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

• vendor/magento/framework/Cache/Frontend/Decorator/Profiler.php