Merge pull request #1773 from XWB/update-resource-owner-map

Use type hints and return types in ResourceOwnerMapInterface
hwi · Aug 3, 2021 · e61c49c · e61c49c
2 parents ec5c799 + 66fa03d
commit e61c49c
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 50 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,10 @@ Changelog
 * BC Break: removed configuration option `fosub` from `oauth_user_provider`,
 * BC Break: removed configuration options `hwi_oauth.fosub`, & all related DI parameters,
 * BC Break: removed DI parameter `hwi_oauth.registration.form.factory` in favour of declaring form class name as DI parameter: `hwi_oauth.connect.registration_form`,
+* BC Break: changed `ResourceOwnerMapInterface::hasResourceOwnerByName` signature, update if you use a custom resource owner,
+* BC Break: changed `ResourceOwnerMapInterface::getResourceOwnerByName` signature, update if you use a custom resource owner,
+* BC Break: changed `ResourceOwnerMapInterface::getResourceOwnerByRequest` signature, update if you use a custom resource owner,
+* BC Break: changed `ResourceOwnerMapInterface::getResourceOwnerCheckPath` signature, update if you use a custom resource owner,
 
 ## 1.4.1 (2021-07-28)
 * Bugfix: Define missing `hwi_oauth.connect.confirmation` parameter,

diff --git a/Security/Http/ResourceOwnerMap.php b/Security/Http/ResourceOwnerMap.php
@@ -28,34 +28,16 @@
  */
 class ResourceOwnerMap implements ContainerAwareInterface, ResourceOwnerMapInterface
 {
-    /**
-     * @var HttpUtils
-     */
-    protected $httpUtils;
-
-    /**
-     * @var array
-     */
-    protected $resourceOwners;
-
-    /**
-     * @var array
-     */
-    protected $possibleResourceOwners;
-
-    /**
-     * @var ContainerInterface
-     */
-    protected $container;
+    protected HttpUtils $httpUtils;
+    protected array $resourceOwners;
+    protected array $possibleResourceOwners;
+    protected ContainerInterface $container;
 
     /**
-     * Constructor.
-     *
-     * @param HttpUtils $httpUtils              HttpUtils
-     * @param array     $possibleResourceOwners array with possible resource owners names
-     * @param array     $resourceOwners         array with configured resource owners
+     * @param array<string, string> $possibleResourceOwners array with possible resource owners names
+     * @param array<string, string> $resourceOwners         array with configured resource owners
      */
-    public function __construct(HttpUtils $httpUtils, array $possibleResourceOwners, $resourceOwners)
+    public function __construct(HttpUtils $httpUtils, array $possibleResourceOwners, array $resourceOwners)
     {
         $this->httpUtils = $httpUtils;
         $this->possibleResourceOwners = $possibleResourceOwners;
@@ -73,15 +55,15 @@ public function setContainer(ContainerInterface $container = null)
     /**
      * {@inheritdoc}
      */
-    public function hasResourceOwnerByName($name)
+    public function hasResourceOwnerByName(string $name): bool
     {
         return isset($this->resourceOwners[$name], $this->possibleResourceOwners[$name]);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getResourceOwnerByName($name)
+    public function getResourceOwnerByName(string $name): ?ResourceOwnerInterface
     {
         if (!$this->hasResourceOwnerByName($name)) {
             return null;
@@ -96,7 +78,7 @@ public function getResourceOwnerByName($name)
     /**
      * {@inheritdoc}
      */
-    public function getResourceOwnerByRequest(Request $request)
+    public function getResourceOwnerByRequest(Request $request): ?array
     {
         foreach ($this->resourceOwners as $name => $checkPath) {
             if ($this->httpUtils->checkRequestPath($request, $checkPath)) {
@@ -117,7 +99,7 @@ public function getResourceOwnerByRequest(Request $request)
     /**
      * {@inheritdoc}
      */
-    public function getResourceOwnerCheckPath($name)
+    public function getResourceOwnerCheckPath(string $name): ?string
     {
         if (isset($this->resourceOwners[$name])) {
             return $this->resourceOwners[$name];
@@ -129,7 +111,7 @@ public function getResourceOwnerCheckPath($name)
     /**
      * {@inheritdoc}
      */
-    public function getResourceOwners()
+    public function getResourceOwners(): array
     {
         return $this->resourceOwners;
     }

diff --git a/Security/Http/ResourceOwnerMapInterface.php b/Security/Http/ResourceOwnerMapInterface.php
@@ -21,42 +21,28 @@ interface ResourceOwnerMapInterface
 {
     /**
      * Check that resource owner with given name exists.
-     *
-     * @param string $name
-     *
-     * @return bool
      */
-    public function hasResourceOwnerByName($name);
+    public function hasResourceOwnerByName(string $name): bool;
 
     /**
      * Gets the appropriate resource owner given the name.
-     *
-     * @param string $name
-     *
-     * @return ResourceOwnerInterface|null
      */
-    public function getResourceOwnerByName($name);
+    public function getResourceOwnerByName(string $name): ?ResourceOwnerInterface;
 
     /**
      * Gets the appropriate resource owner for a request.
-     *
-     * @return array|null
      */
-    public function getResourceOwnerByRequest(Request $request);
+    public function getResourceOwnerByRequest(Request $request): ?array;
 
     /**
      * Gets the check path for given resource name.
-     *
-     * @param string $name
-     *
-     * @return string|null
      */
-    public function getResourceOwnerCheckPath($name);
+    public function getResourceOwnerCheckPath(string $name): ?string;
 
     /**
      * Get all the resource owners.
      *
-     * @return ResourceOwnerInterface[]
+     * @return array<string, string>
      */
-    public function getResourceOwners();
+    public function getResourceOwners(): array;
 }