Jaxon library integration for the Yii framework https://www.jaxon-php.org.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Jaxon Library for Yii

This package integrates the Jaxon library into the Yii 2 framework.


  • Automatically register Jaxon classes from a preset directory.
  • Read Jaxon options from a config file.


Add the following lines in the composer.json file, and run the composer update command.

"require": {
    "jaxon-php/jaxon-yii": "~2.0"

Declare the Jaxon module in the config/web.php file.

    'modules' => [
        'jaxon' => [
            'class' => 'Jaxon\Yii\Module',


The Jaxon library settings are defined in the @app/config/jaxon.php file, and 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 Yii application.

The following options can be defined in the app section of the config file.

Name Description
classes 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 classes array with the following values.

Name Default value Description
directory @app/jaxon/classes 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 Yii controller using the Jaxon library.

namespace app\controllers;

use Yii;
use yii\web\Controller;

class DemoController extends Controller
    public function actionIndex()
        // Set the layout
        $this->layout = 'demo';
        // Get the Jaxon module
        $jaxon = Yii::$app->getModule('jaxon');

        return $this->render('index', array(
            'jaxonCss' => $jaxon->css(),
            'jaxonJs' => $jaxon->js(),
            'jaxonScript' => $jaxon->script()

Before it prints the page, the controller makes a call to $jaxon->register() to export the Jaxon classes. Then it calls the $jaxon->css(), $jaxon->js() and $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 must inherit from \Jaxon\Sentry\Armada. By default, they are located in the @app/jaxon/classes dir of the Yii application, and the associated namespace is \Jaxon\App.

This is an example of a Jaxon class, defined in the @app/jaxon/classes/HelloWorld.php file.

namespace Jaxon\App;

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

Check the jaxon-examples package for more examples.

Request processing

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

The request processing can be customized by extending the default controller and overloading the following method.

  • public function initInstance($instance): called for each instanciated Jaxon class.
  • public function beforeRequest($instance, $method, &$bEndRequest): called before processing the request.
  • public function afterRequest($instance, $method): called after processing the request.

See https://www.jaxon-php.org/docs/armada/bootstrap.html for more information about processing callbacks.


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


The package is licensed under the BSD license.