Profiler
class Profiler
Profiler.
Methods
__construct(ProfilerStorageInterface $storage, LoggerInterface $logger = null, bool $enable = true) | ||
disable() Disables the profiler. | ||
enable() Enables the profiler. | ||
Profile|false | loadProfileFromResponse(Response $response) Loads the Profile for the given Response. | |
Profile | 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. | |
reset() | ||
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. | |
DataCollectorInterface | get(string $name) Gets a Collector by name. |
Details
__construct(ProfilerStorageInterface $storage, LoggerInterface $logger = null, bool $enable = true)
Parameters
ProfilerStorageInterface | $storage | |
LoggerInterface | $logger | |
bool | $enable |
disable()
Disables the profiler.
enable()
Enables the profiler.
Profile|false loadProfileFromResponse(Response $response)
Loads the Profile for the given Response.
Parameters
Response | $response |
Return Value
Profile|false | A Profile instance |
Profile loadProfile(string $token)
Loads the Profile for the given token.
Parameters
string | $token | A token |
Return Value
Profile | A Profile instance |
bool saveProfile(Profile $profile)
Saves a Profile.
Parameters
Profile | $profile |
Return Value
bool |
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.
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 |
Profile|null collect(Request $request, Response $response, Exception $exception = null)
Collects data for the given Response.
Parameters
Request | $request | |
Response | $response | |
Exception | $exception |
Return Value
Profile|null | A Profile instance or null if the profiler is disabled |
reset()
array all()
Gets the Collectors associated with this profiler.
Return Value
array | An array of collectors |
set(array $collectors = array())
Sets the Collectors associated with this profiler.
Parameters
array | $collectors | An array of collectors |
add(DataCollectorInterface $collector)
Adds a Collector.
Parameters
DataCollectorInterface | $collector |
bool has(string $name)
Returns true if a Collector for the given name exists.
Parameters
string | $name | A collector name |
Return Value
bool |
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpKernel/Profiler/Profiler.html