Prepare for phpstan level 3.

FXdSP · Jul 20, 2020 · 02c6031 · 02c6031
1 parent 70ca5a2
commit 02c6031
Show file tree

Hide file tree

Showing 50 changed files with 282 additions and 203 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,7 +1,7 @@
 includes:
     - phpstan-baseline.neon
 parameters:
-    level: 2
+    level: 3
     paths:
         - '%rootDir%/../../../src/'
     excludes_analyse:

diff --git a/src/Propel/Common/Config/ConfigurationManager.php b/src/Propel/Common/Config/ConfigurationManager.php
@@ -62,7 +62,7 @@ public function get()
      * It ca be useful to get, in example, only 'generator' values.
      *
      * @param  string $section the section to be returned
-     * @return array
+     * @return array|null
      */
     public function getSection($section)
     {

diff --git a/src/Propel/Common/Util/SetColumnConverter.php b/src/Propel/Common/Util/SetColumnConverter.php
@@ -24,14 +24,13 @@ class SetColumnConverter
      *
      * @param mixed $val
      * @param array $valueSet
-     * @return int|null
+     * @return string|int
      *
      * @throws SetColumnConverterException
      */
     public static function convertToInt($val, array $valueSet)
     {
         if ($val === null) {
-
             return 0;
         }
         if (!is_array($val)) {
@@ -44,24 +43,24 @@ public static function convertToInt($val, array $valueSet)
             }
             $bitValueArr[array_search($value, $valueSet)] = '1';
         }
-        
+
         return base_convert(implode(array_reverse($bitValueArr)), 2, 10);
     }
 
     /**
-     * Converts set column integer value to corresponding array. 
-     * 
+     * Converts set column integer value to corresponding array.
+     *
      * @param mixed $val
      * @param array $valueSet
-     * 
+     *
      * @return array
      *
      * @throws SetColumnConverterException
      */
     public static function convertIntToArray($val, array $valueSet)
     {
         if ($val === null) {
-            
+
             return [];
         }
         $bitValueArr = array_reverse(str_split(base_convert($val, 10, 2)));
@@ -76,4 +75,4 @@ public static function convertIntToArray($val, array $valueSet)
         }
         return $valueArr;
     }
-}
+}
diff --git a/src/Propel/Generator/Builder/DataModelBuilder.php b/src/Propel/Generator/Builder/DataModelBuilder.php
@@ -59,43 +59,43 @@ abstract class DataModelBuilder
 
     /**
      * Object builder class for current table.
-     * @var DataModelBuilder
+     * @var ObjectBuilder
      */
     private $objectBuilder;
 
     /**
      * Stub Object builder class for current table.
-     * @var DataModelBuilder
+     * @var ObjectBuilder
      */
     private $stubObjectBuilder;
 
     /**
      * Query builder class for current table.
-     * @var DataModelBuilder
+     * @var ObjectBuilder
      */
     private $queryBuilder;
 
     /**
      * Stub Query builder class for current table.
-     * @var DataModelBuilder
+     * @var ObjectBuilder
      */
     private $stubQueryBuilder;
 
     /**
      * TableMap builder class for current table.
-     * @var DataModelBuilder
+     * @var TableMapBuilder
      */
     protected $tablemapBuilder;
 
     /**
      * Stub Interface builder class for current table.
-     * @var DataModelBuilder
+     * @var ObjectBuilder
      */
     private $interfaceBuilder;
 
     /**
      * Stub child object for current table.
-     * @var DataModelBuilder
+     * @var MultiExtendObjectBuilder
      */
     private $multiExtendObjectBuilder;
 
@@ -140,7 +140,9 @@ public function getPluralizer()
     public function getObjectBuilder()
     {
         if (!isset($this->objectBuilder)) {
-            $this->objectBuilder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'object');
+            /** @var ObjectBuilder $builder */
+            $builder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'object');
+            $this->objectBuilder = $builder;
         }
 
         return $this->objectBuilder;
@@ -153,7 +155,9 @@ public function getObjectBuilder()
     public function getStubObjectBuilder()
     {
         if (!isset($this->stubObjectBuilder)) {
-            $this->stubObjectBuilder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'objectstub');
+            /** @var ObjectBuilder $builder */
+            $builder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'objectstub');
+            $this->stubObjectBuilder = $builder;
         }
 
         return $this->stubObjectBuilder;
@@ -166,7 +170,9 @@ public function getStubObjectBuilder()
     public function getQueryBuilder()
     {
         if (!isset($this->queryBuilder)) {
-            $this->queryBuilder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'query');
+            /** @var ObjectBuilder $builder */
+            $builder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'query');
+            $this->queryBuilder = $builder;
         }
 
         return $this->queryBuilder;
@@ -179,7 +185,9 @@ public function getQueryBuilder()
     public function getStubQueryBuilder()
     {
         if (!isset($this->stubQueryBuilder)) {
-            $this->stubQueryBuilder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'querystub');
+            /** @var ObjectBuilder $builder */
+            $builder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'querystub');
+            $this->stubQueryBuilder = $builder;
         }
 
         return $this->stubQueryBuilder;
@@ -192,7 +200,9 @@ public function getStubQueryBuilder()
     public function getTableMapBuilder()
     {
         if (!isset($this->tablemapBuilder)) {
-            $this->tablemapBuilder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'tablemap');
+            /** @var TableMapBuilder $builder */
+            $builder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'tablemap');
+            $this->tablemapBuilder = $builder;
         }
 
         return $this->tablemapBuilder;
@@ -205,7 +215,9 @@ public function getTableMapBuilder()
     public function getInterfaceBuilder()
     {
         if (!isset($this->interfaceBuilder)) {
-            $this->interfaceBuilder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'interface');
+            /** @var ObjectBuilder $builder */
+            $builder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'interface');
+            $this->interfaceBuilder = $builder;
         }
 
         return $this->interfaceBuilder;
@@ -218,7 +230,9 @@ public function getInterfaceBuilder()
     public function getMultiExtendObjectBuilder()
     {
         if (!isset($this->multiExtendObjectBuilder)) {
-            $this->multiExtendObjectBuilder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'objectmultiextend');
+            /** @var MultiExtendObjectBuilder $builder */
+            $builder = $this->getGeneratorConfig()->getConfiguredBuilder($this->getTable(), 'objectmultiextend');
+            $this->multiExtendObjectBuilder= $builder;
         }
 
         return $this->multiExtendObjectBuilder;
@@ -251,7 +265,10 @@ public function getNewBuilder(Table $table, $classname)
      */
     public function getNewObjectBuilder(Table $table)
     {
-        return $this->getGeneratorConfig()->getConfiguredBuilder($table, 'object');
+        /** @var ObjectBuilder $builder */
+        $builder = $this->getGeneratorConfig()->getConfiguredBuilder($table, 'object');
+
+        return $builder;
     }
 
     /**
@@ -265,7 +282,10 @@ public function getNewObjectBuilder(Table $table)
      */
     public function getNewStubObjectBuilder(Table $table)
     {
-        return $this->getGeneratorConfig()->getConfiguredBuilder($table, 'objectstub');
+        /** @var ObjectBuilder $builder */
+        $builder = $this->getGeneratorConfig()->getConfiguredBuilder($table, 'objectstub');
+
+        return $builder;
     }
 
     /**
@@ -279,7 +299,10 @@ public function getNewStubObjectBuilder(Table $table)
      */
     public function getNewQueryBuilder(Table $table)
     {
-        return $this->getGeneratorConfig()->getConfiguredBuilder($table, 'query');
+        /** @var QueryBuilder $builder */
+        $builder = $this->getGeneratorConfig()->getConfiguredBuilder($table, 'query');
+
+        return $builder;
     }
 
     /**
@@ -293,14 +316,17 @@ public function getNewQueryBuilder(Table $table)
      */
     public function getNewStubQueryBuilder(Table $table)
     {
-        return $this->getGeneratorConfig()->getConfiguredBuilder($table, 'querystub');
+        /** @var QueryBuilder $builder */
+        $builder = $this->getGeneratorConfig()->getConfiguredBuilder($table, 'querystub');
+
+        return $builder;
     }
 
     /**
      * Returns new Query Inheritance builder class for this table.
      *
      * @param  Inheritance   $child
-     * @return ObjectBuilder
+     * @return QueryInheritanceBuilder
      */
     public function getNewQueryInheritanceBuilder(Inheritance $child)
     {
@@ -315,7 +341,7 @@ public function getNewQueryInheritanceBuilder(Inheritance $child)
      * Returns new stub Query Inheritance builder class for this table.
      *
      * @param  Inheritance   $child
-     * @return ObjectBuilder
+     * @return QueryInheritanceBuilder
      */
     public function getNewStubQueryInheritanceBuilder(Inheritance $child)
     {
@@ -328,11 +354,17 @@ public function getNewStubQueryInheritanceBuilder(Inheritance $child)
 
     /**
      * Returns new stub Query Inheritance builder class for this table.
-     * @return TableMapBuilder
+     *
+     * @param \Propel\Generator\Model\Table $table
+     *
+     * @return \Propel\Generator\Builder\Om\TableMapBuilder
      */
     public function getNewTableMapBuilder(Table $table)
     {
-        return $this->getGeneratorConfig()->getConfiguredBuilder($table, 'tablemap');
+        /** @var \Propel\Generator\Builder\Om\TableMapBuilder $builder */
+        $builder = $this->getGeneratorConfig()->getConfiguredBuilder($table, 'tablemap');
+
+        return $builder;
     }
 
     /**
@@ -355,15 +387,15 @@ public function getGeneratorConfig()
      * <code>'database.adapter.mysql.tableType</code>
      *
      * @param  string $name
-     * @return string
+     * @return string|null
      */
     public function getBuildProperty($name)
     {
         if ($this->getGeneratorConfig()) {
             return $this->getGeneratorConfig()->getConfigProperty($name);
         }
 
-        return null; // just to be explicit
+        return null;
     }
 
     /**

diff --git a/src/Propel/Generator/Builder/Om/AbstractObjectBuilder.php b/src/Propel/Generator/Builder/Om/AbstractObjectBuilder.php
@@ -174,7 +174,7 @@ protected function hasDefaultValues()
      * @param  string  $hookName The name of the hook as called from one of this class methods, e.g. "preSave"
      * @return boolean
      */
-    public function hasBehaviorModifier($hookName, $modifier = null)
+    public function hasBehaviorModifier($hookName, $modifier = '')
     {
          return parent::hasBehaviorModifier($hookName, 'ObjectBuilderModifier');
     }

diff --git a/src/Propel/Generator/Builder/Om/ExtensionQueryBuilder.php b/src/Propel/Generator/Builder/Om/ExtensionQueryBuilder.php
@@ -98,7 +98,7 @@ protected function addClassClose(&$script)
      * @param  string  $hookName The name of the hook as called from one of this class methods, e.g. "preSave"
      * @return boolean
      */
-    public function hasBehaviorModifier($hookName, $modifier = null)
+    public function hasBehaviorModifier($hookName, $modifier = '')
     {
          return parent::hasBehaviorModifier($hookName, 'QueryBuilderModifier');
     }

diff --git a/src/Propel/Generator/Builder/Om/QueryBuilder.php b/src/Propel/Generator/Builder/Om/QueryBuilder.php
@@ -1714,7 +1714,7 @@ protected function basePostUpdate(\$affectedRows, ConnectionInterface \$con)
      * @param  string  $hookName The name of the hook as called from one of this class methods, e.g. "preSave"
      * @return boolean
      */
-    public function hasBehaviorModifier($hookName, $modifier = null)
+    public function hasBehaviorModifier($hookName, $modifier = '')
     {
         return parent::hasBehaviorModifier($hookName, 'QueryBuilderModifier');
     }

diff --git a/src/Propel/Generator/Builder/Om/TableMapBuilder.php b/src/Propel/Generator/Builder/Om/TableMapBuilder.php
@@ -733,10 +733,10 @@ public function addClearRelatedInstancePool()
     /**
      * Checks whether any registered behavior on that table has a modifier for a hook
      * @param  string  $hookName The name of the hook as called from one of this class methods, e.g. "preSave"
-     * @param  null    $modifier
+     * @param  string  $modifier
      * @return boolean
      */
-    public function hasBehaviorModifier($hookName, $modifier = null)
+    public function hasBehaviorModifier($hookName, $modifier = '')
     {
         return parent::hasBehaviorModifier($hookName, 'TableMapBuilderModifier');
     }

diff --git a/src/Propel/Generator/Builder/Util/SchemaReader.php b/src/Propel/Generator/Builder/Util/SchemaReader.php
@@ -110,13 +110,13 @@ public function setGeneratorConfig(GeneratorConfigInterface $generatorConfig)
      * populated Schema structure.
      *
      * @param  string $xmlFile The input file to parse.
-     * @return Schema populated by <code>xmlFile</code>.
+     * @return Schema|null populated by <code>xmlFile</code>.
      */
     public function parseFile($xmlFile)
     {
         // we don't want infinite recursion
         if ($this->isAlreadyParsed($xmlFile)) {
-            return;
+            return null;
         }
 
         return $this->parseString(file_get_contents($xmlFile), $xmlFile);
@@ -128,14 +128,15 @@ public function parseFile($xmlFile)
      *
      * @param  string $xmlString The input string to parse.
      * @param  string $xmlFile   The input file name.
-     * @return Schema
+     * @return Schema|null
      */
     public function parseString($xmlString, $xmlFile = null)
     {
         // we don't want infinite recursion
         if ($this->isAlreadyParsed($xmlFile)) {
-            return;
+            return null;
         }
+
         // store current schema file path
         $this->schemasTagsStack[$xmlFile] = [];
         $this->currentXmlFile = $xmlFile;