jaxon-php/jaxon-cake

Jaxon library integration for the CakePHP 3 framework

v4.0.0 2022-07-30 14:29 UTC

Requires

• cakephp/cakephp: 4.*
• jaxon-php/jaxon-core: ^4.0

BSD-3-Clause

• Thierry Feuzeu

• php
• cakephp
• ajax
• Jaxon

README

This package integrates the Jaxon library into the CakePHP framework.

Installation

The version 4 of the package requires CakePHP version 4.

Install the package with Composer.

composer require jaxon-php/jaxon-cake ^5.0

Or

{
    "require": {
        "jaxon-php/jaxon-cake": "^5.0",
    }
}

And run composer install.

Load the Jaxon plugin in the src/Application.php file.

    /**
     * Load all the application configuration and bootstrap logic.
     *
     * @return void
     */
    public function bootstrap(): void
    {
        ...

        // Load more plugins here
        $this->addPlugin(\Jaxon\Cake\JaxonPlugin::class, ['routes' => true]);
    }

Load the Jaxon view helper in the src\View\AppView.php file.

    /**
     * Initialization hook method.
     *
     * Use this method to add common initialization code like loading helpers.
     *
     * e.g. `$this->loadHelper('Html');`
     *
     * @return void
     */
    public function initialize(): void
    {
        $this->loadHelper('Jaxon/Cake.Jaxon');
    }

Routing and middlewares

This package provides two middlewares, one to load the Jaxon config, and the other to process Jaxon requests. The Jaxon config middleware must be attached to the routes to all the pages where the Jaxon features are enabled, while the later must be attached to the controller action that processes Jaxon requests.

use Jaxon\Cake\Middleware\ConfigMiddleware as JaxonConfigMiddleware;

$routes->scope('/', function (RouteBuilder $builder) {
    // Register Jaxon middlewares
    $builder->registerMiddleware('jaxon.config', new JaxonConfigMiddleware());

    // Apply the "jaxon.config" middleware to routes to pages that require Jaxon.
    $builder->applyMiddleware('jaxon.config');

    ...
});

Usage

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.

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.

Usage

The javascript and CSS code

The Jaxon view helper provides functions to insert the Jaxon javascript and CSS code into a page.

<!-- The Jaxon CSS code -->
<?= $this->Jaxon->css() ?>

<!-- The Jaxon javascript includes -->
<?= $this->Jaxon->js() ?>

<!-- The Jaxon javascript code -->
<?= $this->Jaxon->script() ?>

The Jaxon classes

The Jaxon classes can inherit from \Jaxon\App\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\App\CallableClass
{
    public function sayHello()
    {
        $this->response->assign('div2', 'innerHTML', 'Hello World!');
        return $this->response;
    }
}

Contribute

• Issue Tracker: github.com/jaxon-php/jaxon-cake/issues
• Source Code: github.com/jaxon-php/jaxon-cake

License

The package is licensed under the BSD license.