Jaxon for Symfony: Jaxon integration for the Symfony framework

Recommend this page to a friend!
  Info   View files Documentation   Demos   View files View files (13)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2021-06-21 (2 months ago) RSS 2.0 feedNot enough user ratingsTotal: 37 All time: 10,211 This week: 186Up
Version License PHP version Categories
jaxon-symfony 2.1.0BSD License5PHP 5, Libraries, Language, AJAX, Traits
Description Author

This package integrates the Jaxon library with the Symfony framework, allowing to make AJAX calls to PHP classes.

This package automatically export all PHP classes installed in a given directory to Javascript, so their methods can be called directly from the browser.

The Jaxon library provides a Response object that allows in the PHP application to modify the content and layout of a page, and execute Javascript code on the client side.

Picture of Thierry Feuzeu
  Performance   Level  
Name: Thierry Feuzeu <contact>
Classes: 13 packages by
Country: Cameroon Cameroon
Innovation award
Innovation award
Nominee: 1x

Details

Jaxon Library for Symfony

This package integrates the Jaxon library into the Symfony framework.

Features

  • Automatically register Jaxon classes from a pre-configured 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": "~3.2"
}

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

jaxon:
    resource: "@JaxonAjaxBundle/Resources/config/routes.yaml"

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

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

Create and edit the config/jaxon.yaml file to suit the needs of your application. A sample config file is available in this repo.

This config file by default registers Jaxon classes in the jaxon/App directory with the \Jaxon\App namespace. Make sure this directory exists, even if it is empty.

Configuration

The settings in the 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 | 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 | 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 | | | | |

Usage

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

namespace App\Controller;

use Symfony\Component\Routing\Annotation\Route;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

use Jaxon\AjaxBundle\Jaxon;

class DemoController extends AbstractController
{
    /
     * @Route("/", name="home")
     */
    public function index(Jaxon $jaxon)
    {
        return $this->render('demo/index.html.twig', [
            '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 jaxon/App dir of the Symfony application, and the associated namespace is \Jaxon\App.

This is a simple example of a Jaxon class, defined in the 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;
    }
}

Request processing

By default, the Jaxon requests are handled by the controller in the src/Controller/JaxonController.php file. The /jaxon route is defined in the src/Resources/config/routes.yaml file, and linked to the JaxonController::index() method.

Contribute

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

License

The package is licensed under the BSD license.

  Jaxon for Symfony DemoExternal page  
  Files folder image Files  
File Role Description
Files folder imageconfig (1 file)
Files folder imagesrc (5 files, 2 directories)
Accessible without login Plain text file .styleci.yml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  config  
File Role Description
  Accessible without login Plain text file jaxon.yaml Data Auxiliary data

  Files folder image Files  /  src  
File Role Description
Files folder imageController (1 file)
Files folder imageResources (1 directory)
  Accessible without login Plain text file Container.php Class Class source
  Accessible without login Plain text file Jaxon.php Class Class source
  Accessible without login Plain text file JaxonAjaxBundle.php Class Class source
  Accessible without login Plain text file Session.php Class Class source
  Accessible without login Plain text file View.php Class Class source

  Files folder image Files  /  src  /  Controller  
File Role Description
  Accessible without login Plain text file JaxonController.php Class Class source

  Files folder image Files  /  src  /  Resources  
File Role Description
Files folder imageconfig (2 files)

  Files folder image Files  /  src  /  Resources  /  config  
File Role Description
  Accessible without login Plain text file routes.yaml Data Auxiliary data
  Accessible without login Plain text file services.yaml Data Auxiliary data

Downloadjaxon-symfony-2021-06-21.zip 8KB
Downloadjaxon-symfony-2021-06-21.tar.gz 6KB
Install with ComposerInstall with Composer
Needed packages  
Class DownloadWhy it is needed Dependency
Jaxon Sentry Download .zip .tar.gz Uses the provided features Required
 Version Control Unique User Downloads Download Rankings  
 100%
Total:37
This week:0
All time:10,211
This week:186Up
For more information send a message to info at phpclasses dot org.