ProfilerStorageInterface.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\HttpKernel\Profiler;


/**
 * ProfilerStorageInterface.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
interface ProfilerStorageInterface {

  /**
   * Finds profiler tokens for the given criteria.
   *
   * @param string $ip     The IP
   * @param string $url    The URL
   * @param string $limit  The maximum number of tokens to return
   * @param string $method The request method
   *
   * @return array An array of tokens
   */
  public function find($ip, $url, $limit, $method);

  /**
   * Reads data associated with the given token.
   *
   * The method returns false if the token does not exists in the storage.
   *
   * @param string $token A token
   *
   * @return Profile The profile associated with token
   */
  public function read($token);

  /**
   * Saves a Profile.
   *
   * @param Profile $profile A Profile instance
   *
   * @return Boolean Write operation successful
   */
  public function write(Profile $profile);

  /**
   * Purges all data from the database.
   */
  public function purge();

}