Fix more docblocks and missing return type docs.

FXdSP · Jul 23, 2020 · 40305f8 · 40305f8
1 parent e420d21
commit 40305f8
Show file tree

Hide file tree

Showing 26 changed files with 177 additions and 60 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -2,6 +2,8 @@ includes:
     - phpstan-baseline.neon
 parameters:
     level: 5
+    checkGenericClassInNonGenericObjectType: false
+    checkMissingIterableValueType: false
     paths:
         - '%rootDir%/../../../src/'
     excludes_analyse:

diff --git a/src/Propel/Common/Config/ConfigurationManager.php b/src/Propel/Common/Config/ConfigurationManager.php
@@ -134,6 +134,7 @@ public function getConnectionParametersArray($section = 'runtime')
      *
      * @param string|null $fileName  Configuration file name or directory in which resides the configuration file.
      * @param array|null $extraConf Array of configuration properties, to be merged with those loaded from file.
+     * @return void
      */
     protected function load($fileName, $extraConf)
     {
@@ -180,11 +181,12 @@ protected function load($fileName, $extraConf)
      * @param array $extraConf Extra configuration to merge before processing. It's useful when a child class overwrite
      *                         the constructor to pass a built-in array of configuration, without load it from file. I.e.
      *                         Propel\Generator\Config\QuickGeneratorConfig class.
+     * @return void
      */
     protected function process($extraConf = null)
     {
         if (null === $extraConf && count($this->config) <= 0) {
-            return null;
+            return;
         }
 
         $processor = new Processor();
@@ -278,6 +280,8 @@ private function getDirs($fileName)
 
     /**
      * Remove empty `slaves` array from configured connections.
+     *
+     * @return void
      */
     private function cleanupSlaveConnections()
     {
@@ -291,6 +295,8 @@ private function cleanupSlaveConnections()
     /**
      * If not defined, set `runtime` and `generator` connections, based on `database.connections` property.
      * Check if runtime and generator connections are correctly defined.
+     *
+     * @return void
      */
     private function cleanupConnections()
     {

diff --git a/src/Propel/Common/Config/Loader/FileLoader.php b/src/Propel/Common/Config/Loader/FileLoader.php
@@ -46,7 +46,7 @@ abstract class FileLoader extends BaseFileLoader
     /**
      * Constructor.
      *
-     * @param FileLocatorInterface $locator A FileLocator instance
+     * @param FileLocatorInterface|null $locator A FileLocator instance
      */
     public function __construct(FileLocatorInterface $locator = null)
     {
@@ -61,11 +61,12 @@ public function __construct(FileLocatorInterface $locator = null)
      * Replaces parameter placeholders (%name%) by their values for all parameters.
      *
      * @param array $configuration The configuration array to resolve
+     * @return array|null
      */
     public function resolveParams(array $configuration)
     {
         if ($this->resolved) {
-            return;
+            return null;
         }
 
         $this->config = $configuration;
@@ -84,7 +85,7 @@ public function resolveParams(array $configuration)
     /**
      * Get the pathof a given resource
      *
-     * @param mixed $file The resource
+     * @param string $file The resource
      *
      * @return array|string
      * @throws \InvalidArgumentException                            If the file is not found

diff --git a/src/Propel/Common/Config/Loader/IniFileLoader.php b/src/Propel/Common/Config/Loader/IniFileLoader.php
@@ -47,12 +47,10 @@ public function supports($resource, $type = null)
     /**
      * Loads a resource, merge it with the default configuration array and resolve its parameters.
      *
-     * @param  mixed  $file The resource
-     * @param  string $type The resource type
+     * @param  string  $file The resource
+     * @param  string|null $type The resource type
      * @return array  The configuration array
      *
-     * @return array
-     *
      * @throws \InvalidArgumentException                                if configuration file not found
      * @throws \Propel\Common\Config\Exception\InvalidArgumentException When ini file is not valid
      * @throws \Propel\Common\Config\Exception\InputOutputException     if configuration file is not readable

diff --git a/src/Propel/Common/Config/Loader/JsonFileLoader.php b/src/Propel/Common/Config/Loader/JsonFileLoader.php
@@ -22,8 +22,8 @@ class JsonFileLoader extends FileLoader
     /**
      * Loads an Json file.
      *
-     * @param mixed  $file The resource
-     * @param string $type The resource type
+     * @param string  $file The resource
+     * @param string|null $type The resource type
      *
      * @return array
      *

diff --git a/src/Propel/Common/Config/Loader/PhpFileLoader.php b/src/Propel/Common/Config/Loader/PhpFileLoader.php
@@ -31,8 +31,8 @@ class PhpFileLoader extends FileLoader
     /**
      * Loads a PHP file.
      *
-     * @param mixed  $file The resource
-     * @param string $type The resource type
+     * @param string  $file The resource
+     * @param string|null $type The resource type
      *
      * @return array
      *

diff --git a/src/Propel/Common/Config/Loader/XmlFileLoader.php b/src/Propel/Common/Config/Loader/XmlFileLoader.php
@@ -22,8 +22,8 @@ class XmlFileLoader extends FileLoader
     /**
      * Loads an Xml file.
      *
-     * @param mixed  $file The resource
-     * @param string $type The resource type
+     * @param string  $file The resource
+     * @param string|null $type The resource type
      *
      * @return array
      *

diff --git a/src/Propel/Common/Config/Loader/YamlFileLoader.php b/src/Propel/Common/Config/Loader/YamlFileLoader.php
@@ -24,8 +24,8 @@ class YamlFileLoader extends FileLoader
     /**
      * Loads a Yaml file.
      *
-     * @param mixed  $file The resource
-     * @param string $type The resource type
+     * @param string  $file The resource
+     * @param string|null $type The resource type
      *
      * @return array
      *

diff --git a/src/Propel/Generator/Application.php b/src/Propel/Generator/Application.php
@@ -7,6 +7,12 @@
 
 class Application extends \Symfony\Component\Console\Application
 {
+    /**
+     * @param \Symfony\Component\Console\Input\InputInterface $input
+     * @param \Symfony\Component\Console\Output\OutputInterface $output
+     *
+     * @return int
+     */
     public function doRun(InputInterface $input, OutputInterface $output)
     {
         if (extension_loaded('xdebug')) {
@@ -16,4 +22,4 @@ public function doRun(InputInterface $input, OutputInterface $output)
         }
         return parent::doRun($input, $output);
     }
-}
+}
diff --git a/src/Propel/Generator/Builder/Om/AbstractOMBuilder.php b/src/Propel/Generator/Builder/Om/AbstractOMBuilder.php
@@ -1085,6 +1085,7 @@ abstract protected function addClassOpen(&$script);
      * drastically change the contents of the generated object class.
      *
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     abstract protected function addClassBody(&$script);
 

diff --git a/src/Propel/Generator/Builder/Om/AbstractObjectBuilder.php b/src/Propel/Generator/Builder/Om/AbstractObjectBuilder.php
@@ -28,6 +28,7 @@ abstract class AbstractObjectBuilder extends AbstractOMBuilder
      * This is here because it is probably generic enough to apply to templates being generated
      * in different PHP versions.
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     protected function addColumnAccessorMethods(&$script)
     {
@@ -75,6 +76,7 @@ protected function addColumnAccessorMethods(&$script)
      * This is here because it is probably generic enough to apply to templates being generated
      * in different PHP versions.
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     protected function addColumnMutatorMethods(&$script)
     {

diff --git a/src/Propel/Generator/Builder/Om/ExtensionObjectBuilder.php b/src/Propel/Generator/Builder/Om/ExtensionObjectBuilder.php
@@ -33,6 +33,7 @@ public function getUnprefixedClassName()
     /**
      * Adds class phpdoc comment and opening of class.
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     protected function addClassOpen(&$script)
     {
@@ -82,6 +83,7 @@ protected function addClassBody(&$script)
     /**
      * Closes class.
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     protected function addClassClose(&$script)
     {

diff --git a/src/Propel/Generator/Builder/Om/ExtensionQueryBuilder.php b/src/Propel/Generator/Builder/Om/ExtensionQueryBuilder.php
@@ -33,6 +33,7 @@ public function getUnprefixedClassName()
     /**
      * Adds class phpdoc comment and opening of class.
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     protected function addClassOpen(&$script)
     {
@@ -84,6 +85,7 @@ protected function addClassBody(&$script)
     /**
      * Closes class.
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     protected function addClassClose(&$script)
     {

diff --git a/src/Propel/Generator/Builder/Om/InterfaceBuilder.php b/src/Propel/Generator/Builder/Om/InterfaceBuilder.php
@@ -34,6 +34,7 @@ public function getUnprefixedClassName()
      * Adds class phpdoc comment and opening of class.
      *
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     protected function addClassOpen(&$script)
     {
@@ -81,6 +82,7 @@ protected function addClassBody(&$script)
     /**
      * Closes class.
      * @param string $script The script will be modified in this method.
+     * @return void
      */
     protected function addClassClose(&$script)
     {