PHP ^7.4 Compatibility (Including 8.1)

.github/workflows/ci.yml

@@ -5,19 +5,23 @@ on:
     branches:
       - 'master'
   pull_request:
+  workflow_dispatch:
 
 jobs:
     testsuite:
+        name: "Test Suite"
         runs-on: ubuntu-18.04
         strategy:
             fail-fast: false
             matrix:
-                php-version: [ '7.3', '7.4', '8.1' ]
+                php-version: [ '7.4', '8.0', '8.1' ]
                 db-type: [ sqlite, mysql, pgsql, agnostic ]
                 symfony-version: [ '4-min', '4-max', '5-min', '5-max' ]
                 exclude:
-                  - php-version: '8.1'
-                    symfony-version: '4-min'
+                  - symfony-version: '4-min'
+                    php-version: '8.0'
+                  - symfony-version: '4-min'
+                    php-version: '8.1'
         steps:
             - name: Install PostgreSQL latest
               if: matrix.db-type == 'pgsql' && matrix.php-version != '7.3'
@@ -120,10 +124,10 @@ jobs:
     code-style-and-static-analysis:
         runs-on: ubuntu-18.04
         steps:
-            - name: Setup PHP 7.4
+            - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
-                  php-version: 7.4
+                  php-version: 8.1
                   extensions: json, libxml, pdo, pdo_mysql, pdo_sqlite, pdo_pgsql, sqlite3
                   coverage: pcov
 

composer.json

@@ -16,25 +16,25 @@
         }
     ],
     "require": {
-        "php": ">=7.3",
+        "php": ">=7.4",
+        "psr/log": "^1.0||^2.0||^3.0",
         "symfony/yaml": "^3.4.0||^4.0.0||^5.0.0",
         "symfony/config": "^3.4.0||^4.0.0||^5.0.0",
         "symfony/console": "^3.4.0||^4.0.0||^5.0.0",
         "symfony/filesystem": "^3.4.0||^4.0.0||^5.0.0",
         "symfony/finder": "^3.4.0||^4.0.0||^5.0.0",
         "symfony/translation": "^3.4.0||^4.0.0||^5.0.0",
         "symfony/validator": "^3.4.0||^4.0.0||^5.0.0",
-        "symfony/polyfill-php73": "^1.8",
-        "psr/log": "^1.0"
+        "symfony/polyfill-php73": "^1.8"
     },
     "require-dev": {
         "ext-pdo": "*",
         "ext-json": "*",
         "monolog/monolog": "^1.3",
-        "phpstan/phpstan": "^1.0.0",
+        "phpstan/phpstan": "^1.2",
         "phpunit/phpunit": "^9.5.0",
         "spryker/code-sniffer": "^0.17.2",
-        "psalm/phar": "4.9.3",
+        "psalm/phar": "^4.14",
         "mikey179/vfsstream": "^1.6"
     },
     "suggest": {

phpstan.neon

@@ -4,6 +4,7 @@ parameters:
     level: 6
     checkGenericClassInNonGenericObjectType: false
     checkMissingIterableValueType: false
+    reportUnmatchedIgnoredErrors: false
     paths:
         - '%rootDir%/../../../src/'
     excludePaths:

src/Propel/Common/Config/Loader/IniFileLoader.php

@@ -28,7 +28,7 @@ class IniFileLoader extends FileLoader
      *
      * @var string
      */
-    private $nestSeparator = '.';
+    private string $nestSeparator = '.';
 
     /**
      * Returns true if this class supports the given resource.

src/Propel/Common/Config/XmlToArrayConverter.php

@@ -87,7 +87,7 @@ protected static function simpleXmlToArray(SimpleXMLElement $xml): array
 
             // if it's not an array, then it was empty, thus a value/string
             if ($child === []) {
-                $child = static::getConvertedXmlValue($v);
+                $child = self::getConvertedXmlValue($v);
             }
 
             // add the children attributes as if they where children
@@ -104,7 +104,7 @@ protected static function simpleXmlToArray(SimpleXMLElement $xml): array
                     if (is_string($child)) {
                         $child = [];
                     }
-                    $child[$ak] = static::getConvertedXmlValue($av);
+                    $child[$ak] = self::getConvertedXmlValue($av);
                 }
             }
 

src/Propel/Generator/Builder/DataModelBuilder.php

@@ -8,7 +8,12 @@
 
 namespace Propel\Generator\Builder;
 
-use BadMethodCallException;
+use Propel\Common\Pluralizer\PluralizerInterface;
+use Propel\Generator\Builder\Om\AbstractObjectBuilder;
+use Propel\Generator\Builder\Om\AbstractOMBuilder;
+use Propel\Generator\Builder\Om\MultiExtendObjectBuilder;
+use Propel\Generator\Builder\Om\ObjectBuilder;
+use Propel\Generator\Builder\Om\TableMapBuilder;
 use Propel\Generator\Config\GeneratorConfigInterface;
 use Propel\Generator\Model\Inheritance;
 use Propel\Generator\Model\Table;
@@ -34,84 +39,84 @@ abstract class DataModelBuilder
      *
      * @var \Propel\Generator\Model\Table
      */
-    private $table;
+    private Table $table;
 
     /**
      * The generator config object holding build properties, etc.
      *
-     * @var \Propel\Generator\Config\GeneratorConfigInterface
+     * @var \Propel\Generator\Config\GeneratorConfigInterface|null
      */
-    private $generatorConfig;
+    private ?GeneratorConfigInterface $generatorConfig = null;
 
     /**
      * An array of warning messages that can be retrieved for display.
      *
      * @var array string[]
      */
-    private $warnings = [];
+    private array $warnings = [];
 
     /**
      * Object builder class for current table.
      *
-     * @var \Propel\Generator\Builder\Om\ObjectBuilder
+     * @var \Propel\Generator\Builder\Om\ObjectBuilder|null
      */
-    private $objectBuilder;
+    private ?ObjectBuilder $objectBuilder = null;
 
     /**
      * Stub Object builder class for current table.
      *
-     * @var \Propel\Generator\Builder\Om\ObjectBuilder
+     * @var \Propel\Generator\Builder\Om\AbstractObjectBuilder|null
      */
-    private $stubObjectBuilder;
+    private ?AbstractObjectBuilder $stubObjectBuilder = null;
 
     /**
      * Query builder class for current table.
      *
-     * @var \Propel\Generator\Builder\Om\ObjectBuilder
+     * @var \Propel\Generator\Builder\Om\AbstractOMBuilder|null
      */
-    private $queryBuilder;
+    private ?AbstractOMBuilder $queryBuilder = null;
 
     /**
      * Stub Query builder class for current table.
      *
-     * @var \Propel\Generator\Builder\Om\ObjectBuilder
+     * @var \Propel\Generator\Builder\Om\AbstractOMBuilder|null
      */
-    private $stubQueryBuilder;
+    private ?AbstractOMBuilder $stubQueryBuilder = null;
 
     /**
      * TableMap builder class for current table.
      *
-     * @var \Propel\Generator\Builder\Om\TableMapBuilder
+     * @var \Propel\Generator\Builder\Om\TableMapBuilder|null
      */
-    protected $tablemapBuilder;
+    protected ?TableMapBuilder $tablemapBuilder = null;
 
     /**
      * Stub Interface builder class for current table.
      *
-     * @var \Propel\Generator\Builder\Om\ObjectBuilder
+     * @var \Propel\Generator\Builder\Om\AbstractOMBuilder|null
      */
-    private $interfaceBuilder;
+    private ?AbstractOMBuilder $interfaceBuilder = null;
 
     /**
      * Stub child object for current table.
      *
-     * @var \Propel\Generator\Builder\Om\MultiExtendObjectBuilder
+     * @var \Propel\Generator\Builder\Om\MultiExtendObjectBuilder|null
      */
-    private $multiExtendObjectBuilder;
+    private ?MultiExtendObjectBuilder $multiExtendObjectBuilder = null;
 
     /**
      * The Pluralizer class to use.
      *
-     * @var \Propel\Common\Pluralizer\PluralizerInterface
+     * @var \Propel\Common\Pluralizer\PluralizerInterface|null
      */
-    private $pluralizer;
+    private ?PluralizerInterface $pluralizer = null;
 
     /**
      * The platform class
      *
      * @var \Propel\Generator\Platform\PlatformInterface
      */
-    protected $platform;
+    protected ?PlatformInterface $platform = null;
 
     /**
      * Creates new instance of DataModelBuilder subclass.
@@ -156,9 +161,9 @@ public function getObjectBuilder()
     /**
      * Returns new or existing stub Object builder class for this table.
      *
-     * @return \Propel\Generator\Builder\Om\ObjectBuilder
+     * @return \Propel\Generator\Builder\Om\AbstractObjectBuilder|null
      */
-    public function getStubObjectBuilder()
+    public function getStubObjectBuilder(): ?AbstractObjectBuilder
     {
         if ($this->stubObjectBuilder === null) {
             /** @var \Propel\Generator\Builder\Om\ObjectBuilder $builder */
@@ -172,9 +177,9 @@ public function getStubObjectBuilder()
     /**
      * Returns new or existing Query builder class for this table.
      *
-     * @return \Propel\Generator\Builder\Om\ObjectBuilder
+     * @return \Propel\Generator\Builder\Om\AbstractOMBuilder|null
      */
-    public function getQueryBuilder()
+    public function getQueryBuilder(): ?AbstractOMBuilder
     {
         if ($this->queryBuilder === null) {
             /** @var \Propel\Generator\Builder\Om\ObjectBuilder $builder */
@@ -188,9 +193,9 @@ public function getQueryBuilder()
     /**
      * Returns new or existing stub Query builder class for this table.
      *
-     * @return \Propel\Generator\Builder\Om\ObjectBuilder
+     * @return \Propel\Generator\Builder\Om\AbstractOMBuilder|null
      */
-    public function getStubQueryBuilder()
+    public function getStubQueryBuilder(): ?AbstractOMBuilder
     {
         if ($this->stubQueryBuilder === null) {
             /** @var \Propel\Generator\Builder\Om\ObjectBuilder $builder */
@@ -220,9 +225,9 @@ public function getTableMapBuilder()
     /**
      * Returns new or existing stub Interface builder class for this table.
      *
-     * @return \Propel\Generator\Builder\Om\ObjectBuilder
+     * @return \Propel\Generator\Builder\Om\AbstractOMBuilder|null
      */
-    public function getInterfaceBuilder()
+    public function getInterfaceBuilder(): ?AbstractOMBuilder
     {
         if ($this->interfaceBuilder === null) {
             /** @var \Propel\Generator\Builder\Om\ObjectBuilder $builder */
@@ -444,16 +449,10 @@ public function setTable(Table $table)
     /**
      * Returns the current Table object.
      *
-     * @throws \BadMethodCallException
-     *
      * @return \Propel\Generator\Model\Table
      */
-    public function getTable()
+    public function getTable(): Table
     {
-        if ($this->table === null) {
-            throw new BadMethodCallException('No $table set to return.');
-        }
-
         return $this->table;
     }
 

src/Propel/Generator/Builder/Om/AbstractOMBuilder.php

@@ -239,9 +239,9 @@ public function getPackagePath()
      * Returns the user-defined namespace for this table,
      * or the database namespace otherwise.
      *
-     * @return string
+     * @return string|null Currently returns null in some cases - should be fixed
      */
-    public function getNamespace()
+    public function getNamespace(): ?string
     {
         return $this->getTable()->getNamespace();
     }
@@ -367,6 +367,11 @@ public function declareClassNamespace($class, $namespace = '', $alias = false)
      */
     protected function needAliasForClassName($class, $classNamespace)
     {
+        // Should remove this check by not allowing nullable return values in getNamespace
+        if ($this->getNamespace() === null) {
+            return false;
+        }
+
         $builderNamespace = trim($this->getNamespace(), '\\');
 
         if ($classNamespace == $builderNamespace) {

src/Propel/Generator/Builder/Om/ClassTools.php

@@ -20,12 +20,16 @@ class ClassTools
     /**
      * Gets just classname, given a dot-path to class.
      *
-     * @param string $qualifiedName
+     * @param string|null $qualifiedName
      *
-     * @return string
+     * @return string|null
      */
-    public static function classname($qualifiedName)
+    public static function classname(?string $qualifiedName): ?string
     {
+        if ($qualifiedName === null) {
+            return null;
+        }
+
         if (false !== $pos = strrpos($qualifiedName, '.')) {
             return substr($qualifiedName, $pos + 1); // start just after '.'
         } elseif (false !== $pos = strrpos($qualifiedName, '\\')) {

src/Propel/Generator/Builder/Om/ObjectBuilder.php

@@ -50,9 +50,9 @@ public function getPackage()
      *
      * @see Propel\Generator\Builder\Om.AbstractOMBuilder::getNamespace()
      *
-     * @return string
+     * @return string|null
      */
-    public function getNamespace()
+    public function getNamespace(): ?string
     {
         if ($namespace = parent::getNamespace()) {
             return $namespace . '\\Base';
@@ -317,7 +317,7 @@ protected function addClassBody(&$script)
         );
 
         $baseClass = $this->getBaseClass();
-        if (strrpos($baseClass, '\\') !== false) {
+        if ($baseClass && strrpos($baseClass, '\\') !== false) {
             $this->declareClasses($baseClass);
         }
 

src/Propel/Generator/Builder/Om/QueryBuilder.php

@@ -38,9 +38,9 @@ public function getPackage()
     /**
      * Returns the namepace for the query object classes.
      *
-     * @return string
+     * @return string|null
      */
-    public function getNamespace()
+    public function getNamespace(): ?string
     {
         if ($namespace = parent::getNamespace()) {
                 return $namespace . '\\Base';

src/Propel/Generator/Builder/Om/QueryInheritanceBuilder.php

@@ -52,9 +52,9 @@ public function getPackage()
     /**
      * Gets the namespace for the [base] object classes.
      *
-     * @return string
+     * @return string|null
      */
-    public function getNamespace()
+    public function getNamespace(): ?string
     {
         if ($namespace = parent::getNamespace()) {
             return $namespace . '\\Base';

src/Propel/Generator/Builder/Om/TableMapBuilder.php

@@ -30,9 +30,9 @@ public function getPackage()
     }
 
     /**
-     * @return string
+     * @return string|null
      */
-    public function getNamespace()
+    public function getNamespace(): ?string
     {
         if (!$namespace = parent::getNamespace()) {
             return 'Map';