File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Readme
Class:	Jaxon for Laravel Laravel plugin to call PHP classes from with AJAX
Author:	By Thierry Feuzeu
Last change:	Added processing callbacks to the request processing controller. Updated class name in the README. Updated class name in the README.
Date:	2 years ago
Size:	`4,684 bytes`

Download

Jaxon Library for Laravel

This package integrates the Jaxon library into the Laravel 5 framework.

Features

Automatically register Jaxon classes from a preset directory.
Read Jaxon options from a file in Laravel config format.

Installation

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

"require": {
    "jaxon-php/jaxon-laravel": "~2.0"
}

Add the following line to the providers entry in the app.php config file.

Jaxon\Laravel\JaxonServiceProvider::class

Add the following line to the aliases entry in the app.php config file.

'LaravelJaxon' => Jaxon\Laravel\Facades\Jaxon::class

Publish the package configuration.

php artisan vendor:publish --tag=config

Edit the config/jaxon.php file to suit the needs of your application.

Configuration

The settings in the 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 Laravel 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 | |------|---------------|-------------| | request.route | jaxon | The named route to the Jaxon request processor | | directory | app_path('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 | | | | |

The route option is overriden by the core.request.uri option of the Jaxon library.

Usage

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

use LaravelJaxon;

class DemoController extends Controller
{
    public function __construct()
    {
        // parent::__construct();
    }

    public function index()
    {
        // Register the Jaxon classes
        LaravelJaxon::register();

        // Print the page
        return view('index', array(
            'JaxonCss' => LaravelJaxon::css(),
            'JaxonJs' => LaravelJaxon::js(),
            'JaxonScript' => LaravelJaxon::script()
        ));
    }
}

Before it prints the page, the controller makes a call to LaravelJaxon::register() to export the Jaxon classes. Then it calls the LaravelJaxon::css(), LaravelJaxon::js() and LaravelJaxon::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 Laravel application, and the associated namespace is \Jaxon\App.

This is a simple 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/Http/Controllers/JaxonController.php file. The /jaxon route is defined in the src/Http/routes.php file, and linked to the JaxonController::process() method.

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

`public function initInstance($instance)`: called for any Jaxon class instanciated.
`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.