Add type hints to codebase

src/Phinx/Config/Config.php

@@ -41,15 +41,15 @@ class Config implements ConfigInterface, NamespaceAwareInterface
     protected $values = [];
 
     /**
-     * @var string
+     * @var string|null
      */
     protected $configFilePath;
 
     /**
      * @param array $configArray Config array
      * @param string|null $configFilePath Config file path
      */
-    public function __construct(array $configArray, $configFilePath = null)
+    public function __construct(array $configArray, ?string $configFilePath = null)
     {
         $this->configFilePath = $configFilePath;
         $this->values = $this->replaceTokens($configArray);
@@ -60,9 +60,9 @@ public function __construct(array $configArray, $configFilePath = null)
      *
      * @param string $configFilePath Path to the Yaml File
      * @throws \RuntimeException
-     * @return \Phinx\Config\Config
+     * @return \Phinx\Config\ConfigInterface
      */
-    public static function fromYaml($configFilePath)
+    public static function fromYaml(string $configFilePath): ConfigInterface
     {
         if (!class_exists('Symfony\\Component\\Yaml\\Yaml', true)) {
             // @codeCoverageIgnoreStart
@@ -88,9 +88,9 @@ public static function fromYaml($configFilePath)
      *
      * @param string $configFilePath Path to the JSON File
      * @throws \RuntimeException
-     * @return \Phinx\Config\Config
+     * @return \Phinx\Config\ConfigInterface
      */
-    public static function fromJson($configFilePath)
+    public static function fromJson(string $configFilePath): ConfigInterface
     {
         if (!function_exists('json_decode')) {
             // @codeCoverageIgnoreStart
@@ -114,9 +114,9 @@ public static function fromJson($configFilePath)
      *
      * @param string $configFilePath Path to the PHP File
      * @throws \RuntimeException
-     * @return \Phinx\Config\Config
+     * @return \Phinx\Config\ConfigInterface
      */
-    public static function fromPhp($configFilePath)
+    public static function fromPhp(string $configFilePath): ConfigInterface
     {
         ob_start();
         /** @noinspection PhpIncludeInspection */
@@ -138,7 +138,7 @@ public static function fromPhp($configFilePath)
     /**
      * @inheritDoc
      */
-    public function getEnvironments()
+    public function getEnvironments(): ?array
     {
         if (isset($this->values) && isset($this->values['environments'])) {
             $environments = [];
@@ -157,7 +157,7 @@ public function getEnvironments()
     /**
      * @inheritDoc
      */
-    public function getEnvironment($name)
+    public function getEnvironment(string $name): ?array
     {
         $environments = $this->getEnvironments();
 
@@ -187,15 +187,15 @@ public function getEnvironment($name)
     /**
      * @inheritDoc
      */
-    public function hasEnvironment($name)
+    public function hasEnvironment(string $name): bool
     {
         return $this->getEnvironment($name) !== null;
     }
 
     /**
      * @inheritDoc
      */
-    public function getDefaultEnvironment()
+    public function getDefaultEnvironment(): string
     {
         // The $PHINX_ENVIRONMENT variable overrides all other default settings
         $env = getenv('PHINX_ENVIRONMENT');
@@ -242,23 +242,23 @@ public function getDefaultEnvironment()
     /**
      * @inheritDoc
      */
-    public function getAlias($alias)
+    public function getAlias($alias): ?string
     {
         return !empty($this->values['aliases'][$alias]) ? $this->values['aliases'][$alias] : null;
     }
 
     /**
      * @inheritDoc
      */
-    public function getAliases()
+    public function getAliases(): array
     {
         return !empty($this->values['aliases']) ? $this->values['aliases'] : [];
     }
 
     /**
      * @inheritDoc
      */
-    public function getConfigFilePath()
+    public function getConfigFilePath(): ?string
     {
         return $this->configFilePath;
     }
@@ -267,7 +267,7 @@ public function getConfigFilePath()
      * @inheritDoc
      * @throws \UnexpectedValueException
      */
-    public function getMigrationPaths()
+    public function getMigrationPaths(): array
     {
         if (!isset($this->values['paths']['migrations'])) {
             throw new UnexpectedValueException('Migrations path missing from config file');
@@ -280,24 +280,11 @@ public function getMigrationPaths()
         return $this->values['paths']['migrations'];
     }
 
-    /**
-     * Gets the base class name for migrations.
-     *
-     * @param bool $dropNamespace Return the base migration class name without the namespace.
-     * @return string
-     */
-    public function getMigrationBaseClassName($dropNamespace = true)
-    {
-        $className = !isset($this->values['migration_base_class']) ? 'Phinx\Migration\AbstractMigration' : $this->values['migration_base_class'];
-
-        return $dropNamespace ? (substr(strrchr($className, '\\'), 1) ?: $className) : $className;
-    }
-
     /**
      * @inheritDoc
      * @throws \UnexpectedValueException
      */
-    public function getSeedPaths()
+    public function getSeedPaths(): array
     {
         if (!isset($this->values['paths']['seeds'])) {
             throw new UnexpectedValueException('Seeds path missing from config file');
@@ -310,13 +297,26 @@ public function getSeedPaths()
         return $this->values['paths']['seeds'];
     }
 
+    /**
+     * Gets the base class name for migrations.
+     *
+     * @param bool $dropNamespace Return the base migration class name without the namespace.
+     * @return string
+     */
+    public function getMigrationBaseClassName(bool $dropNamespace = true): string
+    {
+        $className = !isset($this->values['migration_base_class']) ? 'Phinx\Migration\AbstractMigration' : $this->values['migration_base_class'];
+
+        return $dropNamespace ? (substr(strrchr($className, '\\'), 1) ?: $className) : $className;
+    }
+
     /**
      * Gets the base class name for seeders.
      *
      * @param bool $dropNamespace Return the base seeder class name without the namespace.
      * @return string
      */
-    public function getSeedBaseClassName($dropNamespace = true)
+    public function getSeedBaseClassName(bool $dropNamespace = true): string
     {
         $className = !isset($this->values['seed_base_class']) ? 'Phinx\Seed\AbstractSeed' : $this->values['seed_base_class'];
 
@@ -354,7 +354,7 @@ public function getTemplateClass()
     /**
      * {@inheritdoc}
      */
-    public function getDataDomain()
+    public function getDataDomain(): array
     {
         if (!isset($this->values['data_domain'])) {
             return [];
@@ -366,7 +366,7 @@ public function getDataDomain()
     /**
      * @inheritDoc
      */
-    public function getContainer()
+    public function getContainer(): ?\Psr\Container\ContainerInterface
     {
         if (!isset($this->values['container'])) {
             return null;
@@ -380,7 +380,7 @@ public function getContainer()
      *
      * @return string
      */
-    public function getVersionOrder()
+    public function getVersionOrder(): string
     {
         if (!isset($this->values['version_order'])) {
             return self::VERSION_ORDER_CREATION_TIME;
@@ -394,7 +394,7 @@ public function getVersionOrder()
      *
      * @return bool
      */
-    public function isVersionOrderCreationTime()
+    public function isVersionOrderCreationTime(): bool
     {
         $versionOrder = $this->getVersionOrder();
 
@@ -421,7 +421,7 @@ public function getBootstrapFile()
      * @param array $arr Array to replace
      * @return array
      */
-    protected function replaceTokens(array $arr)
+    protected function replaceTokens(array $arr): array
     {
         // Get environment variables
         // Depending on configuration of server / OS and variables_order directive,
@@ -449,7 +449,7 @@ protected function replaceTokens(array $arr)
      * @param string[] $tokens Array of tokens to search for
      * @return array
      */
-    protected function recurseArrayForTokens($arr, $tokens)
+    protected function recurseArrayForTokens(array $arr, array $tokens): array
     {
         $out = [];
         foreach ($arr as $name => $value) {
@@ -476,7 +476,7 @@ protected function recurseArrayForTokens($arr, $tokens)
      * @param array $options Options
      * @return array
      */
-    protected function parseAgnosticDsn(array $options)
+    protected function parseAgnosticDsn(array $options): array
     {
         $parsed = Util::parseDsn($options['dsn'] ?? '');
         if ($parsed) {
@@ -495,7 +495,7 @@ protected function parseAgnosticDsn(array $options)
      * @param mixed $value Value
      * @return void
      */
-    public function offsetSet($id, $value)
+    public function offsetSet($id, $value): void
     {
         $this->values[$id] = $value;
     }
@@ -522,7 +522,7 @@ public function offsetGet($id)
      * @param mixed $id ID
      * @return bool
      */
-    public function offsetExists($id)
+    public function offsetExists($id): bool
     {
         return isset($this->values[$id]);
     }
@@ -533,7 +533,7 @@ public function offsetExists($id)
      * @param mixed $id ID
      * @return void
      */
-    public function offsetUnset($id)
+    public function offsetUnset($id): void
     {
         unset($this->values[$id]);
     }

src/Phinx/Config/ConfigInterface.php

@@ -24,7 +24,7 @@ interface ConfigInterface extends ArrayAccess
      *
      * @return array|null
      */
-    public function getEnvironments();
+    public function getEnvironments(): ?array;
 
     /**
      * Returns the configuration for a given environment.
@@ -35,59 +35,59 @@ public function getEnvironments();
      * @param string $name Environment Name
      * @return array|null
      */
-    public function getEnvironment($name);
+    public function getEnvironment(string $name): ?array;
 
     /**
      * Does the specified environment exist in the configuration file?
      *
      * @param string $name Environment Name
      * @return bool
      */
-    public function hasEnvironment($name);
+    public function hasEnvironment(string $name): bool;
 
     /**
      * Gets the default environment name.
      *
      * @throws \RuntimeException
      * @return string
      */
-    public function getDefaultEnvironment();
+    public function getDefaultEnvironment(): string;
 
     /**
      * Get the aliased value from a supplied alias.
      *
      * @param string $alias Alias
      * @return string|null
      */
-    public function getAlias($alias);
+    public function getAlias(string $alias): ?string;
 
     /**
      * Get all the aliased values.
      *
      * @return string[]
      */
-    public function getAliases();
+    public function getAliases(): array;
 
     /**
      * Gets the config file path.
      *
      * @return string
      */
-    public function getConfigFilePath();
+    public function getConfigFilePath(): ?string;
 
     /**
      * Gets the paths to search for migration files.
      *
      * @return string[]
      */
-    public function getMigrationPaths();
+    public function getMigrationPaths(): array;
 
     /**
      * Gets the paths to search for seed files.
      *
      * @return string[]
      */
-    public function getSeedPaths();
+    public function getSeedPaths(): array;
 
     /**
      * Get the template file name.
@@ -108,28 +108,28 @@ public function getTemplateClass();
      *
      * @return \Psr\Container\ContainerInterface|null
      */
-    public function getContainer();
+    public function getContainer(): ?\Psr\Container\ContainerInterface;
 
     /**
      * Get the data domain array.
      *
      * @return array
      */
-    public function getDataDomain();
+    public function getDataDomain(): array;
 
     /**
      * Get the version order.
      *
      * @return string
      */
-    public function getVersionOrder();
+    public function getVersionOrder(): string;
 
     /**
      * Is version order creation time?
      *
      * @return bool
      */
-    public function isVersionOrderCreationTime();
+    public function isVersionOrderCreationTime(): bool;
 
     /**
      * Get the bootstrap file path
@@ -144,13 +144,13 @@ public function getBootstrapFile();
      * @param bool $dropNamespace Return the base migration class name without the namespace.
      * @return string
      */
-    public function getMigrationBaseClassName($dropNamespace = true);
+    public function getMigrationBaseClassName(bool $dropNamespace = true): string;
 
     /**
      * Gets the base class name for seeders.
      *
      * @param bool $dropNamespace Return the base seeder class name without the namespace.
      * @return string
      */
-    public function getSeedBaseClassName($dropNamespace = true);
+    public function getSeedBaseClassName(bool $dropNamespace = true): string;
 }