cakephp-tools/docs/Shims.md

Shims and CO

Write cutting edge 2.x code - and prepare for 3.x.

Write smart (future aware) code

• Drop deprecated stuff early.
• Upgrade to new ways as soon as possible and while it's still easy to do so (minor changes well testable).
• Use the current 2.x version and all the new syntax of it (You can leverage the Upgrade shell to automate necessary changes).

See Tips-Upgrading-to-CakePHP-2.x and the plugin in general.

Assert query strings througout the project

Don't use named params anywhere, they will be gone in 3.x anyway.

Default settings for Paginator, ... can be set using Configure:

$config['Paginator'] = array(
	'paramType' => 'querystring'
);

Just make sure, that your AppController extends the Tools.MyController class.

You can also set Configure::write('App.warnAboutNamedParams', true) to get a warning if any of your code still uses the deprecated named params.

FlashMessages

In 3.x there will be a FlashComponent instead. Mine also provides stackable (multi) messages. See https://github.com/dereuromark/cakephp-tools/wiki/Flash-messages for details.

IntegrationTestCase

The ControllerTestCase will be gone in 3.x. Instead there will be a IntegrationTestCase that involves less, but smarter, mocking. I backported a basic version of it in 2.x already. When upgrading you almost have nothing to change in those test case files.

Login/Passwords

Already use the PHP5.5+ password functionality with the ModernPasswordHasher class and the Passwordable behavior. Easily upgradable to 3.x in minutes.

RSS

Use RssView instead of the akward and limited helper approach.

MyCakeTestCase

• testAction() defaults to GET
• TestConsoleOutput() for stdout and stderr instead of mocks

Model shims

In 3.x the updateAll() and deleteAll() won't autojoin anymore. In order to already write future proof versions of that you can use

• updateAllJoinless()
• deleteAllJoinless() In 3.x all you need to do is rename them back again instead of tryig to fix all broken code.

For findById() and exists() there will be get(). You can directly use it via MyModel::get().

More

Templates

Backported StringTemplate class (from CakePHP3.0) can be used to use template based rendering of HTML tags.

Helpers

FormExt and HtmlExt helpers also provide extended functionality and 3.x shims.

Ajax

Use the AjaxView which will easily be upgradable as a clean component approach.