www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/http-kernel/Profiler/ProfilerStorageInterface.php

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