refactor: Add PHP 8+ type declarations for PHPStan Level 5

.github/workflows/CI.yml

@@ -150,8 +150,10 @@ jobs:
       - name: Install Composer Packages
         run: composer install --prefer-dist --no-interaction --no-progress
 
-      - name: Copy database.php
-        run: cp ./tests/config/database.php ./vendor/pieceofcake2/app/config/
+      - name: Copy config
+        run: |
+          cp ./tests/config/database.php ./vendor/pieceofcake2/app/config/
+          cp ./tests/config/Schema/i18n.php ./vendor/pieceofcake2/app/config/Schema/
 
       - name: Make temporary directories writable
         run: |

CHANGELOG.md

@@ -2,6 +2,71 @@
 
 ## Unreleased
 
+### PHPStan Level 5 Compliance & Comprehensive Type Declarations ([PR #32](https://github.com/pieceofcake2/cakephp/pull/32))
+
+Achieved 100% PHPStan Level 5 compliance with comprehensive type declarations across the entire codebase. This represents a major milestone in type safety and static analysis coverage.
+
+#### PHPStan Level 5 Achievement
+- **Static Analysis**: PHPStan Level 5 now passes with zero errors (599 → 0)
+  - Added type declarations to 200+ methods across all core classes
+  - Fixed type coercion issues in transaction handling and return values
+  - Resolved contravariance issues in method signatures
+  - Fixed undefined variable and property errors throughout codebase
+
+#### Comprehensive Type Declarations
+
+**Model Layer:**
+- Model, I18nModel: Complete method signatures with return types
+- Behaviors: TreeBehavior (265 errors), TranslateBehavior, ContainableBehavior, AclBehavior
+- BehaviorCollection, ModelBehavior: Full type coverage
+- AclNode, Permission: Type declarations added
+
+**DataSource Layer:**
+- DboSource: Comprehensive type declarations for all methods
+- Database Drivers: Mysql, Postgres, Sqlite, Sqlserver with full type coverage
+- DataSource, CakeSession, ConnectionManager: Complete type declarations
+- Removed `extract()` usage in `buildColumn()` for better type safety
+
+**Controller Layer:**
+- Controller, Component: Base class type declarations
+- All Auth classes: Authenticators and Authorizers with full type coverage
+- Components: Acl (split PhpAcl into PhpAco/PhpAro classes), Security, RequestHandler, Flash
+- ComponentCollection, Scaffold: Type declarations added
+
+**Console Layer:**
+- Shell, ShellDispatcher: Complete method signatures
+- All Commands: AclShell, ApiShell, SchemaShell, I18nShell, TestShell, ConsoleShell
+- Tasks: ExtractTask with comprehensive type coverage
+- ConsoleOutput, ConsoleInput: Full type declarations
+
+**Core & Utilities:**
+- Configure: Type declarations and bug fixes
+- App, CakeObject: Type declarations
+- CakeEventManager, CakeEvent: Full type coverage
+- L10n, I18n, Multibyte: Complete type declarations
+- CakeText, Folder: Type declarations added
+- LegacyClassLoader: Changed `autoload()` return type to `void` (spl_autoload_register requirement)
+
+**Test Infrastructure:**
+- CakeTestFixture: Updated to match new type signatures
+- Replaced `SqlserverTestResultIterator` with proper PDOStatement mocks
+- Updated all test mocks to return correct types
+
+#### Code Quality Improvements
+- **Multibyte Optimization**: Simplified ASCII character conversion
+  - Removed unnecessary loops in `strtolower()` and `strtoupper()`
+  - Changed from 6-line loop to simple `ord(strtolower(chr($char)))`
+- **EmailConfig Interface**: Added type-safe email configuration
+  - New `EmailConfigInterface` for consistent email configuration
+  - Updated UPGRADE.md with migration guide
+- **Test Mock Improvements**: Enhanced type safety in test mocks
+  - All database transaction mocks now return proper boolean values
+  - Prevents null→false coercion issues with typed return values
+
+#### Breaking Changes
+- `EmailConfig` classes must now implement `EmailConfigInterface`
+- See UPGRADE.md for detailed migration instructions
+
 ### PHPStan Static Analysis & Comprehensive Type Declarations ([PR #31](https://github.com/pieceofcake2/cakephp/pull/31))
 
 Achieved 100% PHPStan level 0 compliance and added comprehensive property type declarations to all CakePHP 2.x core classes using Rector.

UPGRADE.md

@@ -305,6 +305,51 @@ class User extends AppModel
 
 **Your existing non-namespaced application will continue to work without any changes** thanks to the LegacyClassLoader. This migration is completely optional and can be done at your own pace.
 
+### EmailConfig Must Implement EmailConfigInterface ([PR #32](https://github.com/pieceofcake2/cakephp/pull/32))
+
+All email configuration classes must now implement `EmailConfigInterface`. This change improves type safety and ensures consistent email configuration across applications.
+
+#### What Changed
+
+- `EmailConfig` class must implement `Cake\Network\Email\EmailConfigInterface`
+- The interface requires all email configuration classes to define email settings as public properties
+
+#### Impact on Your Application
+
+If you have a custom `EmailConfig` class in `app/Config/email.php` or `config/email.php`, you need to update it to implement the interface:
+
+**Before:**
+```php
+<?php
+class EmailConfig
+{
+    public $default = [
+        'transport' => 'Mail',
+        'from' => 'you@localhost',
+    ];
+}
+```
+
+**After:**
+```php
+<?php
+use Cake\Network\Email\EmailConfigInterface;
+
+class EmailConfig implements EmailConfigInterface
+{
+    public $default = [
+        'transport' => 'Mail',
+        'from' => 'you@localhost',
+    ];
+}
+```
+
+#### Migration Steps
+
+1. Add the `use` statement for `EmailConfigInterface` at the top of your `EmailConfig` class file
+2. Add `implements EmailConfigInterface` to your `EmailConfig` class declaration
+3. Ensure all email configurations are defined as public properties (arrays)
+
 ### Directory Structure Modernization ([PR #21](https://github.com/pieceofcake2/cakephp/pull/21))
 
 - **Directory layout has been restructured to modern standards**

phpcs.xml

@@ -90,7 +90,7 @@
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
         <exclude-pattern>src/Controller/Component/Acl/PhpAcl.php</exclude-pattern>
         <exclude-pattern>src/Error/exceptions.php</exclude-pattern>
-        <exclude-pattern>src/TestSuite/ControllerTestCase.ph</exclude-pattern>
+        <exclude-pattern>src/TestSuite/ControllerTestCase.php</exclude-pattern>
         <exclude-pattern>tests/TestCase/*</exclude-pattern>
     </rule>
 
@@ -113,23 +113,6 @@
         <exclude-pattern>tests/test_app/Plugin/*/Console/Command/*</exclude-pattern>
     </rule>
 
-    <!-- Allow @ error suppression in specific files where it's necessary -->
-    <rule ref="Generic.PHP.NoSilencedErrors.Discouraged">
-        <exclude-pattern>src/basics.php</exclude-pattern>
-        <exclude-pattern>src/functions.php</exclude-pattern>
-        <exclude-pattern>src/Cache/Engine/FileEngine.php</exclude-pattern>
-        <exclude-pattern>src/Console/Shell.php</exclude-pattern>
-        <exclude-pattern>src/Network/CakeResponse.php</exclude-pattern>
-        <exclude-pattern>src/Utility/Folder.php</exclude-pattern>
-        <exclude-pattern>src/View/Helper.php</exclude-pattern>
-        <exclude-pattern>src/View/View.php</exclude-pattern>
-        <exclude-pattern>tests/TestCase/Cache/CacheTest.php</exclude-pattern>
-        <exclude-pattern>tests/TestCase/Cache/Engine/MemcacheEngineTest.php</exclude-pattern>
-        <exclude-pattern>tests/TestCase/Cache/Engine/MemcachedEngineTest.php</exclude-pattern>
-        <exclude-pattern>tests/TestCase/Cache/Engine/RedisEngineTest.php</exclude-pattern>
-        <exclude-pattern>tests/TestCase/Error/ErrorHandlerTest.php</exclude-pattern>
-    </rule>
-
     <!-- Allow non-PascalCase class names in database.php files (CakePHP2 convention) -->
     <rule ref="Squiz.Classes.ValidClassName.NotPascalCase">
         <exclude-pattern>*/database.php</exclude-pattern>

phpstan.neon

@@ -2,23 +2,27 @@ includes:
     - vendor/pieceofcake2/phpstan-cakephp2/extension.neon
 
 parameters:
-    level: 0
+    level: 5
     phpVersion: 80000
     paths:
         - src
     excludePaths:
         - src/Console/Templates/*
+        - src/TestSuite/templates/*
         - src/View/Scaffolds/*
     bootstrapFiles:
         - tests/bootstrap.php
     treatPhpDocTypesAsCertain: false
     ignoreErrors:
         # Ignore deprecated functions that are part of CakePHP 2.x
         - '#Function strftime\(\) is deprecated#'
+        # Ignore mcrypt constants (extension removed in PHP 7.2+)
         - '#Function mcrypt_.*\(\) is deprecated#'
         - '#Function mcrypt_.* not found#'
+        - '#Constant MCRYPT_.* not found#'
         # Config classes (generated at runtime)
         - '#Class EmailConfig not found#'
+        - '# has unknown class DATABASE_CONFIG as its type.#'
     parallel:
         processTimeout: 300.0
         maximumNumberOfProcesses: 4