minor #32201 [Config] Add type-hints to public interfaces and classes (jschaedl)

This PR was squashed before being merged into the 5.0-dev branch (closes #32201).

Discussion
----------

[Config] Add type-hints to public interfaces and classes

| Q             | A
| ------------- | ---
| Branch?       | master <!-- see below -->
| Bug fix?      | no
| New feature?  | no <!-- please update src/**/CHANGELOG.md files -->
| BC breaks?    | no     <!-- see https://symfony.com/bc -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets | #32179  <!-- #-prefixed issue number(s), if any -->
| License       | MIT
| Doc PR        | N/A <!-- required for new features -->

This PR adds type hints to all public interfaces of the Config component.

Commits
-------

e069dc4eda [Config] Add type-hints to public interfaces and classes

src/Symfony/Component/Config/ConfigCacheFactory.php

@@ -35,7 +35,7 @@ class ConfigCacheFactory implements ConfigCacheFactoryInterface
     /**
      * {@inheritdoc}
      */
-    public function cache($file, $callback)
+    public function cache(string $file, $callback)
     {
         if (!\is_callable($callback)) {
             throw new \InvalidArgumentException(sprintf('Invalid type for callback argument. Expected callable, but got "%s".', \gettype($callback)));

src/Symfony/Component/Config/ConfigCacheFactoryInterface.php

@@ -28,5 +28,5 @@ interface ConfigCacheFactoryInterface
      *
      * @return ConfigCacheInterface The cache instance
      */
-    public function cache($file, $callable);
+    public function cache(string $file, $callable);
 }

src/Symfony/Component/Config/ConfigCacheInterface.php

@@ -45,5 +45,5 @@ interface ConfigCacheInterface
      *
      * @throws \RuntimeException When the cache file cannot be written
      */
-    public function write($content, array $metadata = null);
+    public function write(string $content, array $metadata = null);
 }

src/Symfony/Component/Config/Definition/ArrayNode.php

@@ -102,40 +102,32 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
     /**
      * Sets whether to add default values for this array if it has not been
      * defined in any of the configuration files.
-     *
-     * @param bool $boolean
      */
-    public function setAddIfNotSet($boolean)
+    public function setAddIfNotSet(bool $boolean)
     {
-        $this->addIfNotSet = (bool) $boolean;
+        $this->addIfNotSet = $boolean;
     }
 
     /**
      * Sets whether false is allowed as value indicating that the array should be unset.
-     *
-     * @param bool $allow
      */
-    public function setAllowFalse($allow)
+    public function setAllowFalse(bool $allow)
     {
-        $this->allowFalse = (bool) $allow;
+        $this->allowFalse = $allow;
     }
 
     /**
      * Sets whether new keys can be defined in subsequent configurations.
-     *
-     * @param bool $allow
      */
-    public function setAllowNewKeys($allow)
+    public function setAllowNewKeys(bool $allow)
     {
-        $this->allowNewKeys = (bool) $allow;
+        $this->allowNewKeys = $allow;
     }
 
     /**
      * Sets if deep merging should occur.
-     *
-     * @param bool $boolean
      */
-    public function setPerformDeepMerging($boolean)
+    public function setPerformDeepMerging(bool $boolean)
     {
         $this->performDeepMerging = (bool) $boolean;
     }
@@ -146,16 +138,16 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
      * @param bool $boolean To allow extra keys
      * @param bool $remove  To remove extra keys
      */
-    public function setIgnoreExtraKeys($boolean, $remove = true)
+    public function setIgnoreExtraKeys(bool $boolean, $remove = true)
     {
-        $this->ignoreExtraKeys = (bool) $boolean;
+        $this->ignoreExtraKeys = $boolean;
         $this->removeExtraKeys = $this->ignoreExtraKeys && $remove;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function setName($name)
+    public function setName(string $name)
     {
         $this->name = $name;
     }

src/Symfony/Component/Config/Definition/PrototypeNodeInterface.php

@@ -23,5 +23,5 @@ interface PrototypeNodeInterface extends NodeInterface
      *
      * @param string $name The name of the node
      */
-    public function setName($name);
+    public function setName(string $name);
 }

src/Symfony/Component/Config/Definition/VariableNode.php

@@ -56,15 +56,15 @@ class VariableNode extends BaseNode implements PrototypeNodeInterface
      *
      * @param bool $boolean True if this entity will accept empty values
      */
-    public function setAllowEmptyValue($boolean)
+    public function setAllowEmptyValue(bool $boolean)
     {
-        $this->allowEmptyValue = (bool) $boolean;
+        $this->allowEmptyValue = $boolean;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function setName($name)
+    public function setName(string $name)
     {
         $this->name = $name;
     }

src/Symfony/Component/Config/FileLocator.php

@@ -33,7 +33,7 @@ class FileLocator implements FileLocatorInterface
     /**
      * {@inheritdoc}
      */
-    public function locate($name, $currentPath = null, $first = true)
+    public function locate(string $name, string $currentPath = null, $first = true)
     {
         if ('' == $name) {
             throw new \InvalidArgumentException('An empty file name is not valid to be located.');
@@ -81,7 +81,7 @@ class FileLocator implements FileLocatorInterface
      *
      * @return bool
      */
-    private function isAbsolutePath($file)
+    private function isAbsolutePath(string $file)
     {
         if ('/' === $file[0] || '\\' === $file[0]
             || (\strlen($file) > 3 && ctype_alpha($file[0])

src/Symfony/Component/Config/FileLocatorInterface.php

@@ -30,5 +30,5 @@ interface FileLocatorInterface
      * @throws \InvalidArgumentException        If $name is empty
      * @throws FileLocatorFileNotFoundException If a file is not found
      */
-    public function locate($name, $currentPath = null, $first = true);
+    public function locate(string $name, string $currentPath = null, bool $first = true);
 }

src/Symfony/Component/Config/Loader/DelegatingLoader.php

@@ -31,7 +31,7 @@ class DelegatingLoader extends Loader
     /**
      * {@inheritdoc}
      */
-    public function load($resource, $type = null)
+    public function load($resource, string $type = null)
     {
         if (false === $loader = $this->resolver->resolve($resource, $type)) {
             throw new LoaderLoadException($resource, null, null, null, $type);
@@ -43,7 +43,7 @@ class DelegatingLoader extends Loader
     /**
      * {@inheritdoc}
      */
-    public function supports($resource, $type = null)
+    public function supports($resource, string $type = null)
     {
         return false !== $this->resolver->resolve($resource, $type);
     }

src/Symfony/Component/Config/Loader/GlobFileLoader.php

@@ -21,7 +21,7 @@ class GlobFileLoader extends FileLoader
     /**
      * {@inheritdoc}
      */
-    public function load($resource, $type = null)
+    public function load($resource, string $type = null)
     {
         return $this->import($resource);
     }
@@ -29,7 +29,7 @@ class GlobFileLoader extends FileLoader
     /**
      * {@inheritdoc}
      */
-    public function supports($resource, $type = null)
+    public function supports($resource, string $type = null)
     {
         return 'glob' === $type;
     }

src/Symfony/Component/Config/Loader/LoaderInterface.php

@@ -21,22 +21,20 @@ interface LoaderInterface
     /**
      * Loads a resource.
      *
-     * @param mixed       $resource The resource
-     * @param string|null $type     The resource type or null if unknown
+     * @param mixed $resource The resource
      *
      * @throws \Exception If something went wrong
      */
-    public function load($resource, $type = null);
+    public function load($resource, string $type = null);
 
     /**
      * Returns whether this class supports the given resource.
      *
-     * @param mixed       $resource A resource
-     * @param string|null $type     The resource type or null if unknown
+     * @param mixed $resource A resource
      *
      * @return bool True if this class supports the given resource, false otherwise
      */
-    public function supports($resource, $type = null);
+    public function supports($resource, string $type = null);
 
     /**
      * Gets the loader resolver.

src/Symfony/Component/Config/Loader/LoaderResolver.php

@@ -39,7 +39,7 @@ class LoaderResolver implements LoaderResolverInterface
     /**
      * {@inheritdoc}
      */
-    public function resolve($resource, $type = null)
+    public function resolve($resource, string $type = null)
     {
         foreach ($this->loaders as $loader) {
             if ($loader->supports($resource, $type)) {

src/Symfony/Component/Config/Loader/LoaderResolverInterface.php

@@ -26,5 +26,5 @@ interface LoaderResolverInterface
      *
      * @return LoaderInterface|false The loader or false if none is able to load the resource
      */
-    public function resolve($resource, $type = null);
+    public function resolve($resource, string $type = null);
 }

src/Symfony/Component/Config/Resource/SelfCheckingResourceChecker.php

@@ -28,7 +28,7 @@ class SelfCheckingResourceChecker implements ResourceCheckerInterface
         return $metadata instanceof SelfCheckingResourceInterface;
     }
 
-    public function isFresh(ResourceInterface $resource, $timestamp)
+    public function isFresh(ResourceInterface $resource, int $timestamp)
     {
         /* @var SelfCheckingResourceInterface $resource */
         return $resource->isFresh($timestamp);

src/Symfony/Component/Config/ResourceCheckerConfigCache.php

@@ -116,7 +116,7 @@ class ResourceCheckerConfigCache implements ConfigCacheInterface
      *
      * @throws \RuntimeException When cache file can't be written
      */
-    public function write($content, array $metadata = null)
+    public function write(string $content, array $metadata = null)
     {
         $mode = 0666;
         $umask = umask();

src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php

@@ -32,7 +32,7 @@ class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface
     /**
      * {@inheritdoc}
      */
-    public function cache($file, $callback)
+    public function cache(string $file, $callback)
     {
         if (!\is_callable($callback)) {
             throw new \InvalidArgumentException(sprintf('Invalid type for callback argument. Expected callable, but got "%s".', \gettype($callback)));

src/Symfony/Component/Config/ResourceCheckerInterface.php

@@ -44,5 +44,5 @@ interface ResourceCheckerInterface
      *
      * @return bool True if the resource has not changed since the given timestamp, false otherwise
      */
-    public function isFresh(ResourceInterface $resource, $timestamp);
+    public function isFresh(ResourceInterface $resource, int $timestamp);
 }

src/Symfony/Component/Config/Tests/FileLocatorTest.php

@@ -115,6 +115,6 @@ class FileLocatorTest extends TestCase
     {
         $loader = new FileLocator([__DIR__.'/Fixtures']);
 
-        $loader->locate(null, __DIR__);
+        $loader->locate('', __DIR__);
     }
 }