Download the PHP package ali1/cakephp-json-tools without Composer
On this page you can find all versions of the php package ali1/cakephp-json-tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package cakephp-json-tools
CakePHP Json Tools Plugin
A CakePHP plugin to assist with creating Json responses from controllers.
Json Tools has been created to be used by traditional CakePHP projects which are mostly browser-based, but have a few AJAX or API methods. The Json Tools component makes creating these a breeze.
Features
- A component that quickly lets you set up ajax methods.
- Works with CakePHP's ResponseHandler so you don't have to
- Can be used in methods that sometimes output Html and other times Json depending on request headers, just like normal CakePHP behavior
Requirements
- Composer
- CakePHP 4.0+ (see releases for working 3.7+ release)
- PHP 7.2+
Installation
In your CakePHP root directory: run the following command:
Then in your Application.php in your project root, add the following snippet:
or you can use the following shell command to enable to plugin in your bootstrap.php automatically:
Now add it to your src/AppController.php or to specific controllers
Usage (in controller methods that may need to output Json)
Understanding the boiler plate Json output
This component primes ResponseHandler to output something that looks like this:
Which corresponds to a json output of:
Your controller method can then override these keys or add new ones easily using this component.
Priming the method with boiler-plate Json output
Setting the JSON output
Boiler plate output keys (see above) could be overwritten later in your method using one of these methods
Example controller
Example AJAX form
This is an example form that corresponds to the ajaxUpdateUser method above.
templates/Users/edit.php
webroot/ajax_submit.js