A CakePHP plugin to shim applications between major framework versions.
Shim plugin to "shim" functionality up and down for CakePHP major versions. It also provides some small app-specific fixes.
It provides compatibility wrapper access to 2.x functionality in 3.x.
This is mainly useful when upgrading large applications to the next major framework version. Tons of code needs to be adjusted, using this Shim plugin quite a few lines less need to be touched. Especially the ORM layer, which would need heavy refactoring, requires a lot less changes to get things working again.
It also contains useful 4.x preparation shims.
This branch is for use with CakePHP 3.7+. For details see version map.
Please see SETUP.md
Please see Docs.
A full overview of all shimming between 2.x and 3.x can be found in the Wiki.
- Common component and Nullable behavior for better data consistency.
- TraitCast for clean and safe request handling.
- Auto-adds Timestamp behavior if
modifiedfield exists in table.
- Get/Read trait for clean and speaking entity access.
Only for 2.x => 3.x shimming: Ccontinue to provide support for some 2.x functioality in 3.x.
- Contains Session component as compatibility wrapper for request session object (and Session helper).
- Primary level
- Primary level
fieldByConditions()alias to migrate to.
- Still supports model properties
$actsAsand all relations (
$hasMany, ...) as it would be very time-consuming to manually adjust all those.
- Shims controller
$useswith deprecation warning.
For 4.x compatibility of 3.x apps: Make your 3.x app future proof.
- Controller referer() local security fix
- BoolType, StringType, DecimalType, JsonType behave like in 4.x
- Table newEmptyEntity() method available
For 3.x => 4.x: Report early on about what can be changed to prepare for 4.x.
When planning to upgrade, you should look into the upgrade plugin for 2.x and upgrade app for 3.x. They both extend the core ones and contain tons of more ideas on how to get code aligned with the current direction of the framework to reduce friction in the long run.