class Profiler

Profiler.

Methods

__construct(ProfilerStorageInterface $storage, LoggerInterface $logger = null)

Constructor.

disable()

Disables the profiler.

enable()

Enables the profiler.

loadProfileFromResponse(Response $response)

Loads the Profile for the given Response.

loadProfile(string $token)

Loads the Profile for the given token.

bool
saveProfile(Profile $profile)

Saves a Profile.

purge()

Purges all data from the storage.

array
find(string $ip, string $url, string $limit, string $method, string $start, string $end, string $statusCode = null)

Finds profiler tokens for the given criteria.

Profile|null
collect(Request $request, Response $response, Exception $exception = null)

Collects data for the given Response.

array
all()

Gets the Collectors associated with this profiler.

set(array $collectors = array())

Sets the Collectors associated with this profiler.

add(DataCollectorInterface $collector)

Adds a Collector.

bool
has(string $name)

Returns true if a Collector for the given name exists.

get(string $name)

Gets a Collector by name.

Details

at line line 54
__construct(ProfilerStorageInterface $storage, LoggerInterface $logger = null)

Constructor.

Parameters

ProfilerStorageInterface $storage A ProfilerStorageInterface instance
LoggerInterface $logger A LoggerInterface instance

at line line 63
disable()

Disables the profiler.

at line line 71
enable()

Enables the profiler.

at line line 83
Profile loadProfileFromResponse(Response $response)

Loads the Profile for the given Response.

Parameters

Response $response A Response instance

Return Value

Profile A Profile instance

at line line 99
Profile loadProfile(string $token)

Loads the Profile for the given token.

Parameters

string $token A token

Return Value

Profile A Profile instance

at line line 111
bool saveProfile(Profile $profile)

Saves a Profile.

Parameters

Profile $profile A Profile instance

Return Value

bool

at line line 130
purge()

Purges all data from the storage.

at line line 150
array find(string $ip, string $url, string $limit, string $method, string $start, string $end, string $statusCode = null)

Finds profiler tokens for the given criteria.

Parameters

string $ip The IP
string $url The URL
string $limit The maximum number of tokens to return
string $method The request method
string $start The start date to search from
string $end The end date to search to
string $statusCode The request status code

Return Value

array An array of tokens

See also

http://php.net/manual/en/datetime.formats.php for the supported date/time formats

at line line 164
Profile|null collect(Request $request, Response $response, Exception $exception = null)

Collects data for the given Response.

Parameters

Request $request A Request instance
Response $response A Response instance
Exception $exception An exception instance if the request threw one

Return Value

Profile|null A Profile instance or null if the profiler is disabled

at line line 198
array all()

Gets the Collectors associated with this profiler.

Return Value

array An array of collectors

at line line 208
set(array $collectors = array())

Sets the Collectors associated with this profiler.

Parameters

array $collectors An array of collectors

at line line 221
add(DataCollectorInterface $collector)

Adds a Collector.

Parameters

DataCollectorInterface $collector A DataCollectorInterface instance

at line line 233
bool has(string $name)

Returns true if a Collector for the given name exists.

Parameters

string $name A collector name

Return Value

bool

at line line 247
DataCollectorInterface get(string $name)

Gets a Collector by name.

Parameters

string $name A collector name

Return Value

DataCollectorInterface A DataCollectorInterface instance

Exceptions

InvalidArgumentException if the collector does not exist