interface ProfilerStorageInterface

ProfilerStorageInterface.

This interface exists for historical reasons. The only supported implementation is FileProfilerStorage.

As the profiler must only be used on non-production servers, the file storage is more than enough and no other implementations will ever be supported.

Methods

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

Finds profiler tokens for the given criteria.

read(string $token)

Reads data associated with the given token.

bool
write(Profile $profile)

Saves a Profile.

purge()

Purges all data from the database.

Details

at line 41
array find(string $ip, string $url, string $limit, string $method, int|null $start = null, int|null $end = 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
int|null $start The start date to search from
int|null $end The end date to search to

Return Value

array An array of tokens

at line 52
Profile read(string $token)

Reads data associated with the given token.

The method returns false if the token does not exist in the storage.

Parameters

string $token A token

Return Value

Profile The profile associated with token

at line 59
bool write(Profile $profile)

Saves a Profile.

Parameters

Profile $profile

Return Value

bool Write operation successful

at line 64
purge()

Purges all data from the database.