annotate vendor/symfony/http-kernel/Profiler/ProfilerStorageInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\HttpKernel\Profiler;
Chris@0 13
Chris@0 14 /**
Chris@0 15 * ProfilerStorageInterface.
Chris@0 16 *
Chris@0 17 * @author Fabien Potencier <fabien@symfony.com>
Chris@0 18 */
Chris@0 19 interface ProfilerStorageInterface
Chris@0 20 {
Chris@0 21 /**
Chris@0 22 * Finds profiler tokens for the given criteria.
Chris@0 23 *
Chris@0 24 * @param string $ip The IP
Chris@0 25 * @param string $url The URL
Chris@0 26 * @param string $limit The maximum number of tokens to return
Chris@0 27 * @param string $method The request method
Chris@0 28 * @param int|null $start The start date to search from
Chris@0 29 * @param int|null $end The end date to search to
Chris@0 30 *
Chris@0 31 * @return array An array of tokens
Chris@0 32 */
Chris@0 33 public function find($ip, $url, $limit, $method, $start = null, $end = null);
Chris@0 34
Chris@0 35 /**
Chris@0 36 * Reads data associated with the given token.
Chris@0 37 *
Chris@0 38 * The method returns false if the token does not exist in the storage.
Chris@0 39 *
Chris@0 40 * @param string $token A token
Chris@0 41 *
Chris@0 42 * @return Profile The profile associated with token
Chris@0 43 */
Chris@0 44 public function read($token);
Chris@0 45
Chris@0 46 /**
Chris@0 47 * Saves a Profile.
Chris@0 48 *
Chris@0 49 * @return bool Write operation successful
Chris@0 50 */
Chris@0 51 public function write(Profile $profile);
Chris@0 52
Chris@0 53 /**
Chris@0 54 * Purges all data from the database.
Chris@0 55 */
Chris@0 56 public function purge();
Chris@0 57 }