Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dereuromark/cakephp-shim
CakePHP plugin to "shim" functionality up and down for major versions of the framework.
https://github.com/dereuromark/cakephp-shim
cakephp cakephp-plugin compatibility-wrapper php shim
Last synced: 7 days ago
JSON representation
CakePHP plugin to "shim" functionality up and down for major versions of the framework.
- Host: GitHub
- URL: https://github.com/dereuromark/cakephp-shim
- Owner: dereuromark
- License: mit
- Created: 2015-01-27T00:44:45.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T13:32:54.000Z (24 days ago)
- Last Synced: 2024-10-18T11:54:29.312Z (22 days ago)
- Topics: cakephp, cakephp-plugin, compatibility-wrapper, php, shim
- Language: PHP
- Homepage:
- Size: 942 KB
- Stars: 37
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cakephp - Shim plugin - A plugin containing useful shims and improvements as basis for your application. (Miscellaneous)
README
# Shim plugin for CakePHP
[](https://github.com/dereuromark/cakephp-shim/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://codecov.io/gh/dereuromark/cakephp-shim)
[](https://packagist.org/packages/dereuromark/cakephp-shim)
[](https://php.net/)
[](LICENSE)
[](https://packagist.org/packages/dereuromark/cakephp-shim)
[](https://github.com/php-fig-rectified/fig-rectified-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 4.x in 5.x
It provides compatibility wrapper access to 4.x functionality in 5.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.
This branch is for use with **CakePHP 5.0+**. For details see [version map](https://github.com/dereuromark/cakephp-shim/wiki#cakephp-version-map).
## Installation
Please see [Install.md](docs/Install.md)
## Usage
Please see [Docs](docs/README.md).
A full overview of all shimming between versions can be found in the [Wiki](https://github.com/dereuromark/cakephp-shim/wiki).
## New shims
- RequestHandler component for continued easier View class switching across the app
- LegacyModelAwareTrait for loadModel() shimming
- former Cake\Filesystem\File and Cake\Filesystem\Folder classes
- ModifiedTrait for entities and detecting actually changed fields (not just touched with same value)
Note: AuthComponent lives on in 5.x via [TinyAuth plugin](https://github.com/dereuromark/cakephp-tinyauth) if needed.
## Existing shims from 4.x
- Controller setup for components and helpers
- Nullable behavior for better data consistency.
- `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.
- Auto-adds Timestamp behavior if `created` or `modified` field exists in table.
## Helpful links
When planning to upgrade, you should look into official [upgrade docs](https://book.cakephp.org/5/en/appendices/5-0-upgrade-guide.html) as well as the linked upgrade tool.
They both 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.
Also see my blog post [dereuromark.de/2023/09/28/cakephp-5-upgrade-guide/](https://www.dereuromark.de/2023/09/28/cakephp-5-upgrade-guide/).