Jaxon Library for CakePHP
This package integrates the Jaxon library into the CakePHP framework, versions 3 and 4.
Read Jaxon options from a file in CakePHP config format.
Automatically register Jaxon classes from a preset directory.
First install CakePHP version 3 or 4.
For CakePHP 4, install the version
3.2.* of the Jaxon plugin, and for CakePHP 3, installe the version
Add the the following content in the
composer.json file and run
Register the Jaxon plugin in the
'plugins' => [
'Jaxon/Cake' => $baseDir . '/vendor/jaxon-php/jaxon-cake/',
Load the Jaxon plugin.
./bin/cake plugin load "Jaxon/Cake"
If you need to call Jaxon in your controller, you must also load the Jaxon component.
The settings in the
config/jaxon.php config file are separated into two sections.
The options in the
lib section are those of the Jaxon core library, while the options in the
app sections are those of the CakePHP application.
The following options can be defined in the
app section of the config file.
| Name | Description |
| directories | An array of directory containing Jaxon application classes |
| views | An array of directory containing Jaxon application views |
| | | |
By default, the
views array is empty. Views are rendered from the framework default location.
There's a single entry in the
directories array with the following values.
| Name | Default value | Description |
| directory | ROOT . '/jaxon/App' | The directory of the Jaxon classes |
| namespace | \Jaxon\App | The namespace of the Jaxon classes |
| separator | . | The separator in Jaxon class names |
| protected | empty array | Prevent Jaxon from exporting some methods |
| | | |
This is an example of a CakePHP controller using the Jaxon library.
class DemoController extends AppController
// Remove the return type (void) if you are using CakePHP 3.
public function initialize(): void
// Load the Jaxon component
public function index()
Before it prints the page, the controller calls the
The Jaxon classes
The Jaxon classes can inherit from
By default, they are located in the
ROOT/jaxon/App dir of the CakePHP application, and the associated namespace is
This is an example of a Jaxon class, defined in the
class HelloWorld extends \Jaxon\CallableClass
public function sayHello()
$this->response->assign('div2', 'innerHTML', 'Hello World!');
By default, the Jaxon request are handled by the controller in the
/jaxon route is defined in the
config/routes.php file, and linked to the
Issue Tracker: github.com/jaxon-php/jaxon-cake/issues
Source Code: github.com/jaxon-php/jaxon-cake
The package is licensed under the BSD license.