CakePHP plugin to "shim" functionality up and down for major versions of the framework.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config assert action names. Jan 3, 2016
docs Switch to https. Jan 6, 2019
src Fix phpstan level 5. Jan 22, 2019
tests Upgrade fixture loading Jan 1, 2019
.editorconfig Add php5.6 to travis Jan 3, 2016
.gitattributes composer json Jan 27, 2015
.gitignore Add YearType. Oct 31, 2016
.travis.yml Update plugin travis. Jan 6, 2019
LICENSE LICENSE Jan 7, 2016
README.md Switch to https. Jan 6, 2019
composer.json Fix phpstan level 5. Jan 22, 2019
phpunit.xml.dist Remove deprecations. Oct 28, 2018

README.md

Shim plugin for CakePHP

Build Status Coverage Latest Stable Version Minimum PHP Version License Total Downloads Coding Standards

Shim plugin to "shim" functionality up and down for CakePHP major versions. It also provides some small app-specific fixes.

This branch is for shimming 2.x in 3.x

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 againc.

This branch requires CakePHP 3.7+

Installation

Please see SETUP.md

Usage

Please see Docs.

A full overview of all shimming between 2.x and 3.x can be found in the Wiki.

Main shims

  • Nullable behavior for better data consistency.
  • Primary level Table::find('first') support.
  • Primary level Table::find('count') support.
  • Table::field() support and fieldByConditions() alias to migrate to.
  • Still supports model properties $primaryKey, $displayField, $order, $validate, $actsAs and all relations ($belongsTo, $hasMany, ...) as it would be very time-consuming to manually adjust all those.
  • Contains Session component as compatibility wrapper for request session object (and maybe also for Session helper if that one gets deprecated in 3.x).
  • Auto-adds Timestamp behavior if created or modified field exists in table.

Helpful links

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.