#15343 - Improve stubs

.github/workflows/build-and-test.yml

@@ -150,11 +150,6 @@ jobs:
         with:
           fetch-depth: 1
 
-      - name: Install System Dependencies
-        run: |
-          sudo apt-get update --quiet --yes 1>/dev/null
-          sudo apt-get install --no-install-recommends -q -y re2c
-
       - name: Get Composer Cache Directory
         id: composer-cache
         run: |

.github/workflows/static-code-analysis.yml

@@ -5,19 +5,13 @@ on:
     paths-ignore:
       - '**.md'
       - '**.txt'
-  pull_request:
-    branches:
-      - master
-      - 4.0.x
-      - 4.1.x
 
 jobs:
   phpcs:
-    # To prevent build a particular commit use
-    #     git commit -m "......... [ci skip]"
     if: "!contains(github.event.head_commit.message, 'ci skip')"
 
     runs-on: ubuntu-20.04
+    name: Tests code style validation
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
@@ -26,3 +20,43 @@ jobs:
 
       - name: Run PHP_CodeSniffer
         run: docker run --rm -v $(pwd):/data cytopia/phpcs --standard=./phpcs.xml
+
+  stubs:
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: [ '7.4', '8.0' ]
+
+    name: Stubs code validation in PHP ${{ matrix.php-versions }}
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          tools: pecl
+          extensions: mbstring, intl, json, imagick, redis, igbinary, apcu, msgpack, memcached, yaml, psr
+
+      - name: Install System Dependencies
+        run: |
+          sudo apt-get update --quiet --yes 1>/dev/null
+          sudo apt-get install --no-install-recommends -q -y re2c
+
+      - name: Install Packages
+        run: composer install --prefer-dist --ignore-platform-reqs
+
+      - name: Install Zephir
+        run: .ci/install-zephir.sh
+
+      - name: Validate stubs
+        if: always()
+        run: |
+          $HOME/bin/zephir stubs
+          vendor/bin/psalm ide/

CHANGELOG-5.0.md

@@ -11,6 +11,7 @@
 - Changed `Phalcon\Mvc\Model::getSchema()`, `Phalcon\Mvc\ModelInterface::getSchema()`, `Phalcon\Mvc\Model\Manager::getModelSchema()` `Phalcon\Mvc\Model\ManagerInterface::getModelSchema()` to return `string | null` so as to abide with the latest Zephir [#15411](https://github.com/phalcon/cphalcon/issues/15411)
 - Changed the interpolation for the formatters to use the `Phalcon\Support\Helper\Str\Interpolate` [#15411](https://github.com/phalcon/cphalcon/issues/15411)
 - Changed the exceptions thrown from factories to be more specific to their namespaces vs. the Factory generic one [#15411](https://github.com/phalcon/cphalcon/issues/15411)
+- Changed `Phalcon\Mvc\Model\ManagerInterface:getRelationByAlias()` return type from `Relation|bool` to `RelationInterface|bool` [#15343](https://github.com/phalcon/cphalcon/issues/15343)
 
 ## Added
 - Added `BINARY` and `VARBINARY` support for Phalcon\Db\Adapter\Mysql [#14927](https://github.com/phalcon/cphalcon/issues/14927)
@@ -48,3 +49,7 @@
 - Fixed declarations for `function getEventsManager()` to allow null return [15010](https://github.com/phalcon/cphalcon/issues/15010)
 - Removed underscore from method names (starting) to abide with PSR-12 [15345](https://github.com/phalcon/cphalcon/issues/15345)
 - Fixed `Phalcon\Flash\Session::has()` to properly check if any messages are existing [15204](https://github.com/phalcon/cphalcon/issues/15204)
+- Fixed signature of `Phalcon\Forms\Element\Select::__construct()`
+- Fixed signature of `Phalcon\Assets\Manager::addCss()`
+- Fixed signature of `Phalcon\Assets\Manager::addJs()`
+- Fixed signature of `Phalcon\Db\Adapter\AdapterInterface::execute()`, `Phalcon\Db\Adapter\AdapterInterface::fetchOne()` and `Phalcon\Db\Adapter\AdapterInterface::query()`

composer.json

@@ -65,6 +65,7 @@
         "predis/predis": "^1.1",
         "squizlabs/php_codesniffer": "^3.4",
         "twig/twig": "~1.36",
+        "vimeo/psalm": "^4.7",
         "vlucas/phpdotenv": "^2.5"
     },
     "config": {

phalcon/Acl/Adapter/AdapterInterface.zep

@@ -21,7 +21,7 @@ interface AdapterInterface
     /**
      * Do a role inherit from another existing role
      */
-    public function addInherit(string roleName, roleToInherit) -> bool;
+    public function addInherit(string roleName, roleToInherits) -> bool;
 
     /**
      * Adds a role to the ACL list. Second parameter lets to inherit access data
@@ -35,7 +35,7 @@ interface AdapterInterface
      * Access names can be a particular action, by example
      * search, update, delete, etc or a list of them
      */
-    public function addComponent(componentObject, accessList) -> bool;
+    public function addComponent(componentValue, accessList) -> bool;
 
     /**
      * Adds access to components

phalcon/Assets/Manager.zep

@@ -324,7 +324,7 @@ class Manager extends AbstractInjectionAware
     /**
      * Traverses a collection calling the callback to generate its HTML
      *
-     * @param callback callback
+     * @param Collection callback
      * @param string type
      */
     public function output(<Collection> collection, callback, type) -> string | null

phalcon/Cli/Router/Route.zep

@@ -66,7 +66,7 @@ class Route implements RouteInterface
      * The developer can implement any arbitrary conditions here
      * If the callback returns false the route is treated as not matched
      *
-     * @param callback callback
+     * @param mixed callback
      */
     public function beforeMatch(var callback) -> <RouteInterface>
     {
@@ -392,7 +392,10 @@ class Route implements RouteInterface
     /**
      * Reconfigure the route adding a new pattern and a set of paths
      *
-     * @param array|string paths
+     * @param string pattern
+     * @param array|string|null paths
+     *
+     * @return void
      */
     public function reConfigure(string! pattern, paths = null) -> void
     {

phalcon/Cli/Router/RouteInterface.zep

@@ -68,6 +68,11 @@ interface RouteInterface
 
     /**
      * Reconfigure the route adding a new pattern and a set of paths
+     *
+     * @param string pattern
+     * @param array|string|null paths
+     *
+     * @return void
      */
     public function reConfigure(string! pattern, var paths = null) -> void;
 

phalcon/Cli/Task.zep

@@ -39,6 +39,9 @@ use Phalcon\Events\ManagerInterface;
  */
 class Task extends Injectable implements TaskInterface, EventsAwareInterface
 {
+    /**
+     * @var ManagerInterface
+     */
     protected eventsManager;
 
     /**

phalcon/DataMapper/Pdo/Connection/AbstractConnection.zep

@@ -29,7 +29,7 @@ use Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface;
 abstract class AbstractConnection implements ConnectionInterface
 {
     /**
-     * @var PDO
+     * @var \PDO
      */
     protected pdo;
 
@@ -395,7 +395,7 @@ abstract class AbstractConnection implements ConnectionInterface
     /**
      * Return the inner PDO (if any)
      *
-     * @return PDO
+     * @return \PDO
      */
     public function getAdapter() -> <\PDO>
     {
@@ -562,7 +562,7 @@ abstract class AbstractConnection implements ConnectionInterface
      * @param string $statement
      * @param array  $values
      *
-     * @return PDOStatement
+     * @return \PDOStatement
      */
     public function perform(
         string statement,
@@ -592,7 +592,7 @@ abstract class AbstractConnection implements ConnectionInterface
      * @param string $statement
      * @param array  $options
      *
-     * @return PDOStatement|false
+     * @return \PDOStatement|false
      */
     public function prepare(
         string statement,
@@ -618,7 +618,7 @@ abstract class AbstractConnection implements ConnectionInterface
      * @param string $statement
      * @param mixed  ...$fetch
      *
-     * @return PDOStatement|false
+     * @return \PDOStatement|false
      */
     public function query(string statement) -> <\PDOStatement> | bool
     {
@@ -725,9 +725,9 @@ abstract class AbstractConnection implements ConnectionInterface
     /**
      * Bind a value using the proper PDO::PARAM_* type.
      *
-     * @param PDOStatement $statement
-     * @param mixed        $name
-     * @param mixed        $arguments
+     * @param \PDOStatement $statement
+     * @param mixed         $name
+     * @param mixed         $arguments
      */
     protected function performBind(
         <\PDOStatement> statement,

phalcon/DataMapper/Pdo/Connection/ConnectionInterface.zep

@@ -172,7 +172,7 @@ interface ConnectionInterface extends PdoInterface
     /**
      * Return the inner PDO (if any)
      *
-     * @return PDO
+     * @return \PDO
      */
     public function getAdapter() -> <\PDO>;
 
@@ -199,7 +199,7 @@ interface ConnectionInterface extends PdoInterface
      * @param string $statement
      * @param array  $values
      *
-     * @return PDOStatement
+     * @return \PDOStatement
      */
     public function perform(string statement, array values = []) -> <\PDOStatement>;
 

phalcon/DataMapper/Pdo/Connection/Decorated.zep

@@ -31,7 +31,7 @@ class Decorated extends AbstractConnection
      * This overrides the parent so that it can take an existing PDO instance
      * and decorate it with the extended methods.
      *
-     * @param PDO                    $pdo
+     * @param \PDO                   $pdo
      * @param ProfilerInterface|null $profiler
      *
      */

phalcon/DataMapper/Pdo/Connection/PdoInterface.zep

@@ -101,7 +101,7 @@ interface PdoInterface
      * @param string $statement
      * @param array  $options
      *
-     * @return PDOStatement|false
+     * @return \PDOStatement|false
      */
     public function prepare(string statement, array options = []) -> <\PDOStatement> | bool;
 
@@ -112,7 +112,7 @@ interface PdoInterface
      * @param string $statement
      * @param mixed  ...$fetch
      *
-     * @return PDOStatement|false
+     * @return \PDOStatement|false
      */
     public function query(string statement) -> <\PDOStatement> | bool;
 

phalcon/DataMapper/Pdo/Profiler/MemoryLogger.zep

@@ -34,11 +34,83 @@ class MemoryLogger extends AbstractLogger
      *
      * @return array
      */
-    public function getMessages()
+    public function getMessages() -> array
     {
         return this->messages;
     }
 
+    /**
+     * @param string message
+     * @param mixed[] context
+     */
+    public function emergency(var message, array context = [])
+    {
+        parent::emergency(message, context);
+    }
+
+    /**
+     * @param string message
+     * @param mixed[] context
+     */
+    public function alert(var message, array context = [])
+    {
+        parent::alert(message, context);
+    }
+
+    /**
+     * @param string message
+     * @param mixed[] context
+     */
+    public function critical(var message, array context = [])
+    {
+        parent::critical(message, context);
+    }
+
+    /**
+     * @param string message
+     * @param mixed[] context
+     */
+    public function error(var message, array context = [])
+    {
+        parent::error(message, context);
+    }
+
+    /**
+     * @param string message
+     * @param mixed[] context
+     */
+    public function warning(var message, array context = [])
+    {
+        parent::warning(message, context);
+    }
+
+    /**
+     * @param string message
+     * @param mixed[] context
+     */
+    public function notice(var message, array context = [])
+    {
+        parent::notice(message, context);
+    }
+
+    /**
+     * @param string message
+     * @param mixed[] context
+     */
+    public function info(var message, array context = [])
+    {
+        parent::info(message, context);
+    }
+
+    /**
+     * @param string message
+     * @param mixed[] context
+     */
+    public function debug(var message, array context = [])
+    {
+        parent::debug(message, context);
+    }
+
     /**
      * Logs a message.
      *

phalcon/DataMapper/Query/AbstractQuery.zep

@@ -122,7 +122,7 @@ abstract class AbstractQuery
     /**
      * Performs a statement in the connection
      *
-     * @return PDOStatement
+     * @return \PDOStatement
      */
     public function perform()
     {

phalcon/DataMapper/Query/Insert.zep

@@ -41,7 +41,7 @@ class Insert extends AbstractQuery
      *
      * @param string $column
      *
-     * @return this
+     * @return Insert
      */
     public function column(string column, var value = null, int type = -1) -> <Insert>
     {
@@ -59,7 +59,7 @@ class Insert extends AbstractQuery
      *
      * @param array $columns
      *
-     * @return this
+     * @return Insert
      */
     public function columns(array columns) -> <Insert>
     {