PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of Thierry Feuzeu  >  Jaxon for Laravel  >  README.md  >  Download  
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
Last change: Updated the readme.
Updated version numbers.
Removed the Facade class.
Typo fix in readme.
The Container class now implements the PSR-11 ContainerInterface.
Updated the readme.
Updated the readme.
Date: 1 year ago
Size: 3,350 bytes
 

Contents

Class file image 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": "^3.2"
}

If you have installed a version prior to 3.2, add the following line to the providers entry in the app.php config file.

Jaxon\Laravel\JaxonServiceProvider::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 | |------|---------------| | 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 | app_path('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 | | | | |

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 Jaxon\Laravel\Jaxon;

class DemoController extends Controller
{
    public function index(Jaxon $jaxon)
    {
        // Print the page
        return view('index', [
            'JaxonCss' => $jaxon->css(),
            'JaxonJs' => $jaxon->js(),
            'JaxonScript' => $jaxon->script()
        ]);
    }
}

Before it prints the page, the controller 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 can inherit from \Jaxon\CallableClass. By default, they are located in the app/Jaxon/App 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/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;
    }
}

Contribute

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

License

The package is licensed under the BSD license.