[RateLimiter] Add RateLimitFactoryInterface

Nathan Salter · Nathan Salter · commit ecd611cccdcd · 2022-06-11T09:28:18.000+01:00
Adds an interface for the `RateLimitFactory` to allow alternative integrations or use in unit tests. See Issue #46644
diff --git a/src/Symfony/Component/RateLimiter/CHANGELOG.md b/src/Symfony/Component/RateLimiter/CHANGELOG.md
@@ -1,5 +1,8 @@
 CHANGELOG
 =========
+6.1
+---
+ * Switch to use an Interface for the `RateLimiterFactory`
 
 5.4
 ---
diff --git a/src/Symfony/Component/RateLimiter/RateLimiterFactory.php b/src/Symfony/Component/RateLimiter/RateLimiterFactory.php
@@ -25,7 +25,7 @@
 /**
  * @author Wouter de Jong <wouter@wouterj.nl>
  */
-final class RateLimiterFactory
+final class RateLimiterFactory implements RateLimiterFactoryInterface
 {
     private array $config;
     private StorageInterface $storage;
diff --git a/src/Symfony/Component/RateLimiter/RateLimiterFactoryInterface.php b/src/Symfony/Component/RateLimiter/RateLimiterFactoryInterface.php
@@ -0,0 +1,17 @@
+<?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\RateLimiter;
+
+interface RateLimiterFactoryInterface
+{
+    public function create(string $key = null): LimiterInterface;
+}

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`/**`
`26`	`26`	`* @author Wouter de Jong <wouter@wouterj.nl>`
`27`	`27`	`*/`
`28`		`-final class RateLimiterFactory`
	`28`	`+final class RateLimiterFactory implements RateLimiterFactoryInterface`
`29`	`29`	`{`
`30`	`30`	`private array $config;`
`31`	`31`	`private StorageInterface $storage;`