Jaxon Library for Symfony

This package integrates the Jaxon library into the Symfony framework.

Features

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

Installation

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

"require": {
    "jaxon-php/jaxon-symfony": "1.0.*"
}

Declare the Jaxon bundle in the app/AppKernel.php file.

$bundles = array(
    ...
    new Jaxon\AjaxBundle\JaxonAjaxBundle(),
);

Setup the default routing for Jaxon request by adding the following line in the app/config/routing.yml config file.

jaxon_ajax:
    resource: "@JaxonAjaxBundle/Resources/config/routing.yml"
    prefix:   /

Import the service definition and configuration file of the Jaxon bundle in the app/config/config.yml config file.

imports:
    ...
    - { resource: "@JaxonAjaxBundle/Resources/config/services.yml" }

Create and edit the app/config/jaxon.yml file to suit the needs of your application. A sample config file is available online in the examples repo.

Configuration

The settings in the app/config/jaxon.yml 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 Symfony application.

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

Name	Default value	Description
dir	/src/Jaxon/App	The directory of the Jaxon classes
namespace	\Jaxon\App	The namespace of the Jaxon classes
excluded	empty array	Prevent Jaxon from exporting some methods

Usage

This is an example of a Symfony controller using the Jaxon library.

namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;

class DemoController extends Controller
{
    public function indexAction(Request $request)
    {
        // Register the Jaxon classes
        $jaxon = $this->get('jaxon.ajax');
        $jaxon->register();
        // Print the page
        return $this->render('demo/index.html.twig',
            'jaxon_css' => $jaxon->css(),
            'jaxon_js' => $jaxon->js(),
            'jaxon_script' => $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 in the page.

The Jaxon classes

The Jaxon classes of the application must all be located in the directory indicated by the app.dir option in the jaxon.yml config file. If there is a namespace associated, the app.namespace option should be set accordingly. The app.namespace option must be explicitely set to null, false or an empty string if there is no namespace.

By default, the Jaxon classes are located in the src/Jaxon/App dir of the Symfony application, and the associated namespace is \Jaxon\App.

Contribute

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

License

The project is licensed under the BSD license.