Jaxon library integration for the CakePHP 3 framework

v3.2.1 2021-02-14 20:25 UTC


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 3.1.*. Add the the following content in the composer.json file and run composer install.

    "require": {
        "jaxon-php/jaxon-cake": "3.2.*",

Register the Jaxon plugin in the vendor/cakephp-plugins.php file.

return [
    '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.

namespace App\Controller;

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()
        $this->set('jaxonCss', $this->Jaxon->css());
        $this->set('jaxonJs', $this->Jaxon->js());
        $this->set('jaxonScript', $this->Jaxon->script());

Before it prints the page, the controller calls the $this->Jaxon->css(), $this->Jaxon->js() and $this->Jaxon->script() functions to get the CSS and javascript codes generated by Jaxon, which it inserts into the page.

The Jaxon classes

The Jaxon classes can inherit from \Jaxon\CallableClass. By default, they are located in the ROOT/jaxon/App dir of the CakePHP application, and the associated namespace is \Jaxon\App.

This is an example of a Jaxon class, defined in the ROOT/jaxon/App/HelloWorld.php file.

namespace Jaxon\App;

class HelloWorld extends \Jaxon\CallableClass
    public function sayHello()
        $this->response->assign('div2', 'innerHTML', 'Hello World!');
        return $this->response;

Request processing

By default, the Jaxon request are handled by the controller in the src/Controller/JaxonController.php file. The /jaxon route is defined in the config/routes.php file, and linked to the JaxonController::index() method.


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