[Summary view] [Print] [Text view]

   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\Config;
  13  
  14  use Symfony\Component\Config\Resource\ResourceInterface;
  15  
  16  /**
  17   * Interface for ResourceCheckers.
  18   *
  19   * When a ResourceCheckerConfigCache instance is checked for freshness, all its associated
  20   * metadata resources are passed to ResourceCheckers. The ResourceCheckers
  21   * can then inspect the resources and decide whether the cache can be considered
  22   * fresh or not.
  23   *
  24   * @author Matthias Pigulla <mp@webfactory.de>
  25   * @author Benjamin Klotz <bk@webfactory.de>
  26   */
  27  interface ResourceCheckerInterface
  28  {
  29      /**
  30       * Queries the ResourceChecker whether it can validate a given
  31       * resource or not.
  32       *
  33       * @param ResourceInterface $metadata The resource to be checked for freshness
  34       *
  35       * @return bool True if the ResourceChecker can handle this resource type, false if not
  36       */
  37      public function supports(ResourceInterface $metadata);
  38  
  39      /**
  40       * Validates the resource.
  41       *
  42       * @param ResourceInterface $resource  The resource to be validated
  43       * @param int               $timestamp The timestamp at which the cache associated with this resource was created
  44       *
  45       * @return bool True if the resource has not changed since the given timestamp, false otherwise
  46       */
  47      public function isFresh(ResourceInterface $resource, $timestamp);
  48  }