RequestRateLimiterInterface.php 761 B

1234567891011121314151617181920212223242526272829303132
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpFoundation\RateLimiter;
  11. use Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\RateLimiter\RateLimit;
  13. /**
  14. * A special type of limiter that deals with requests.
  15. *
  16. * This allows to limit on different types of information
  17. * from the requests.
  18. *
  19. * @author Wouter de Jong <wouter@wouterj.nl>
  20. *
  21. * @experimental in 5.3
  22. */
  23. interface RequestRateLimiterInterface
  24. {
  25. public function consume(Request $request): RateLimit;
  26. public function reset(Request $request): void;
  27. }