PHP Classes
elePHPant
Icontem

Jaxon for Yii: Yi plugin to call PHP from with AJAX

Recommend this page to a friend!
  Info   View files Documentation   View files View files (9)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2017-09-24 (1 month ago) RSS 2.0 feedNot enough user ratingsTotal: 53 All time: 9,021 This week: 589Up
Version License PHP version Categories
jaxon-yii 2.0.1BSD License5PHP 5, Libraries, AJAX, Traits
Description Author

This package integrates the Jaxon library with the Yii 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.

  Performance   Level  
Name: Thierry Feuzeu <contact>
Classes: 11 packages by
Country: Cameroon Cameroon
Age: 41
All time rank: 27173 in Cameroon Cameroon
Week rank: 70 Up1 in Cameroon Cameroon Up
Innovation award
Innovation award
Nominee: 1x

Details

Jaxon Library for Yii

This package integrates the Jaxon library into the Yii 2 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-yii": "~2.0"
}

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

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

Configuration

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 | | | | |

Usage

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');
        $jaxon->register();

        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.

Contribute

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

License

The package is licensed under the BSD license.

  Files folder image Files  
File Role Description
Files folder imageconfig (1 file)
Files folder imagesrc (3 files, 1 directory)
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.php Aux. Auxiliary script

  Files folder image Files  /  src  
File Role Description
Files folder imageControllers (1 file)
  Accessible without login Plain text file Module.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  /  Controllers  
File Role Description
  Accessible without login Plain text file JaxonController.php Class Class source

Downloadjaxon-yii-2017-09-24.zip 7KB
Downloadjaxon-yii-2017-09-24.tar.gz 5KB
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:53
This week:0
All time:9,021
This week:589Up