Upgrade to cakephp-cs 5 and add type declarations

composer.json

@@ -48,7 +48,7 @@
  "phpunit/phpunit": "^9.5.19",
  "sebastian/comparator": ">=1.2.3",
  "cakephp/cakephp": "^5.0",
- "cakephp/cakephp-codesniffer": "^4.0",
+ "cakephp/cakephp-codesniffer": "^5.0",
  "symfony/yaml": "^3.4|^4.0|^5.0|^6.0"
  },
  "autoload": {

phpcs.xml

@@ -2,16 +2,12 @@
 <ruleset name="Phinx">
  <config name="installed_paths" value="../../cakephp/cakephp-codesniffer"/>
 
+ <rule ref="CakePHP"/>
+
  <arg value="nps"/>
 
  <file>src/</file>
  <file>tests/</file>
 
  <exclude-pattern>*_files*</exclude-pattern>
-
- <rule ref="CakePHP"/>
-
- <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
- <severity>0</severity>
- </rule>
 </ruleset>

phpstan-baseline.neon

@@ -15,13 +15,3 @@ parameters:
  count: 2
  path: src/Phinx/Db/Adapter/SqlServerAdapter.php
 
- -
- message: "#^Property Phinx\\\\Migration\\\\Manager\\\\Environment\\:\\:\\$adapter \\(Phinx\\\\Db\\\\Adapter\\\\AdapterInterface\\) in isset\\(\\) is not nullable\\.$#"
- count: 1
- path: src/Phinx/Migration/Manager/Environment.php
-
- -
- message: "#^Unreachable statement \\- code above always terminates\\.$#"
- count: 1
- path: src/Phinx/Migration/Manager/Environment.php
-

src/Phinx/Config/Config.php

@@ -12,15 +12,13 @@
 use Phinx\Db\Adapter\SQLiteAdapter;
 use Phinx\Util\Util;
 use Psr\Container\ContainerInterface;
+use ReturnTypeWillChange;
 use RuntimeException;
 use Symfony\Component\Yaml\Yaml;
 use UnexpectedValueException;
 
 /**
  * Phinx configuration class.
- *
- * @package Phinx
- * @author Rob Morgan
  */
 class Config implements ConfigInterface, NamespaceAwareInterface
 {
@@ -42,12 +40,12 @@ class Config implements ConfigInterface, NamespaceAwareInterface
  /**
  * @var array
  */
- protected $values = [];
+ protected array $values = [];
 
  /**
  * @var string|null
  */
- protected $configFilePath;
+ protected ?string $configFilePath = null;
 
  /**
  * @param array $configArray Config array
@@ -328,7 +326,7 @@ public function getSeedBaseClassName(bool $dropNamespace = true): string
  /**
  * @inheritdoc
  */
- public function getTemplateFile()
+ public function getTemplateFile(): string|false
  {
  if (!isset($this->values['templates']['file'])) {
  return false;
@@ -340,7 +338,7 @@ public function getTemplateFile()
  /**
  * @inheritdoc
  */
- public function getTemplateClass()
+ public function getTemplateClass(): string|false
  {
  if (!isset($this->values['templates']['class'])) {
  return false;
@@ -410,7 +408,7 @@ public function isVersionOrderCreationTime(): bool
  /**
  * @inheritdoc
  */
- public function getBootstrapFile()
+ public function getBootstrapFile(): string|false
  {
  if (!isset($this->values['paths']['bootstrap'])) {
  return false;
@@ -511,7 +509,7 @@ public function offsetSet($id, $value): void
  * @throws \InvalidArgumentException
  * @return mixed
  */
- #[\ReturnTypeWillChange]
+ #[ReturnTypeWillChange]
  public function offsetGet($id)
  {
  if (!array_key_exists($id, $this->values)) {

src/Phinx/Config/ConfigInterface.php

@@ -12,9 +12,6 @@
 
 /**
  * Phinx configuration interface.
- *
- * @package Phinx
- * @author Woody Gilk
  */
 interface ConfigInterface extends ArrayAccess
 {
@@ -95,14 +92,14 @@ public function getSeedPaths(): array;
  *
  * @return string|false
  */
- public function getTemplateFile();
+ public function getTemplateFile(): string|false;
 
  /**
  * Get the template class name.
  *
  * @return string|false
  */
- public function getTemplateClass();
+ public function getTemplateClass(): string|false;
 
  /**
  * Get the template style to use, either change or up_down.
@@ -144,7 +141,7 @@ public function isVersionOrderCreationTime(): bool;
  *
  * @return string|false
  */
- public function getBootstrapFile();
+ public function getBootstrapFile(): string|false;
 
  /**
  * Gets the base class name for migrations.

src/Phinx/Config/FeatureFlags.php

@@ -17,11 +17,11 @@ class FeatureFlags
  /**
  * @var bool Should Phinx create unsigned primary keys by default?
  */
- public static $unsignedPrimaryKeys = true;
+ public static bool $unsignedPrimaryKeys = true;
  /**
  * @var bool Should Phinx create columns NULL by default?
  */
- public static $columnNullDefault = true;
+ public static bool $columnNullDefault = true;
 
  /**
  * Set the feature flags from the `feature_flags` section of the overall

src/Phinx/Config/NamespaceAwareInterface.php

@@ -9,9 +9,6 @@
 
 /**
  * Config aware getNamespaceByPath method.
- *
- * @package Phinx\Config
- * @author Andrey N. Mokhov
  */
 interface NamespaceAwareInterface
 {

src/Phinx/Config/NamespaceAwareTrait.php

@@ -9,9 +9,6 @@
 
 /**
  * Trait implemented NamespaceAwareInterface.
- *
- * @package Phinx\Config
- * @author Andrey N. Mokhov
  */
 trait NamespaceAwareTrait
 {

src/Phinx/Console/Command/AbstractCommand.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -23,8 +24,6 @@
 
 /**
  * Abstract command, contains bootstrapping info
- *
- * @author Rob Morgan <robbym@gmail.com>
  */
 abstract class AbstractCommand extends Command
 {
@@ -52,22 +51,22 @@ abstract class AbstractCommand extends Command
  /**
  * @var \Phinx\Config\ConfigInterface|null
  */
- protected $config;
+ protected ?ConfigInterface $config = null;
 
  /**
  * @var \Phinx\Db\Adapter\AdapterInterface
  */
- protected $adapter;
+ protected AdapterInterface $adapter;
 
  /**
  * @var \Phinx\Migration\Manager
  */
- protected $manager;
+ protected Manager $manager;
 
  /**
  * @var int
  */
- protected $verbosityLevel = OutputInterface::OUTPUT_NORMAL | OutputInterface::VERBOSITY_NORMAL;
+ protected int $verbosityLevel = OutputInterface::OUTPUT_NORMAL | OutputInterface::VERBOSITY_NORMAL;
 
  /**
  * Exit code for when command executes successfully
@@ -235,7 +234,7 @@ public function setManager(Manager $manager)
  */
  public function getManager(): ?Manager
  {
- return $this->manager;
+ return $this->manager ?? null;
  }
 
  /**
@@ -342,7 +341,7 @@ protected function loadConfig(InputInterface $input, OutputInterface $output): v
  */
  protected function loadManager(InputInterface $input, OutputInterface $output): void
  {
- if ($this->getManager() === null) {
+ if (!isset($this->manager)) {
  $manager = new Manager($this->getConfig(), $input, $output);
  $manager->setVerbosityLevel($this->verbosityLevel);
  $container = $this->getConfig()->getContainer();

src/Phinx/Console/Command/Breakpoint.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -19,6 +20,7 @@ class Breakpoint extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'breakpoint';
 
  /**

src/Phinx/Console/Command/Create.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -27,6 +28,7 @@ class Create extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'create';
 
  /**

src/Phinx/Console/Command/Init.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -23,7 +24,7 @@ class Init extends Command
  /**
  * @var string[]
  */
- protected static $supportedFormats = [
+ protected static array $supportedFormats = [
  AbstractCommand::FORMAT_JSON,
  AbstractCommand::FORMAT_YML_ALIAS,
  AbstractCommand::FORMAT_YML,
@@ -33,6 +34,7 @@ class Init extends Command
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'init';
 
  /**

src/Phinx/Console/Command/ListAliases.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -18,6 +19,7 @@ class ListAliases extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'list:aliases';
 
  /**

src/Phinx/Console/Command/Migrate.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -21,6 +22,7 @@ class Migrate extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'migrate';
 
  /**

src/Phinx/Console/Command/Rollback.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -20,6 +21,7 @@ class Rollback extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'rollback';
 
  /**

src/Phinx/Console/Command/SeedCreate.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -26,6 +27,7 @@ class SeedCreate extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'seed:create';
 
  /**

src/Phinx/Console/Command/SeedRun.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -18,6 +19,7 @@ class SeedRun extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'seed:run';
 
  /**

src/Phinx/Console/Command/Status.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -18,6 +19,7 @@ class Status extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'status';
 
  /**

src/Phinx/Console/Command/Test.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 /**
  * MIT License
@@ -21,6 +22,7 @@ class Test extends AbstractCommand
  /**
  * @var string|null
  */
+ // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
  protected static $defaultName = 'test';
 
  /**