PHP Classes
elePHPant
Icontem

Jaxon for CodeIgniter: CodeIgniter plugin to call PHP from with AJAX

Recommend this page to a friend!
  Info   View files Documentation   Demos   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 (2 months ago) RSS 2.0 feedNot enough user ratingsTotal: 135 This week: 1All time: 8,576 This week: 586Up
Version License PHP version Categories
jaxon-codeigniter 2.0.1BSD License5PHP 5, Utilities and Tools, Libraries, A..., P...
Description Author

This package integrates the Jaxon library with the CodeIgniter 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: 12 packages by
Country: Cameroon Cameroon
Age: 41
All time rank: 26703 in Cameroon Cameroon
Week rank: 57 Up1 in Cameroon Cameroon Up
Innovation award
Innovation award
Nominee: 1x

Details

Jaxon Library for CodeIgniter

This package integrates the Jaxon library into the CodeIgniter 3 framework.

Features

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

Installation

First install CodeIgniter version 3.

Create the composer.json file into the installation dir with the following content.

{
    "require": {
        "jaxon-php/jaxon-codeigniter": "~2.0",
    }
}

Copy the content of the app/ directory of this repo to the application/ dir of the CodeIgniter application. This will install the Jaxon library for CodeIgniter, as well as the controller to process Jaxon requests and a default config file.

The version 3 of the CodeIgniter framework does not natively support Composer. The Composer vendor/autoload.php file must therefore be manually included in the 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 CodeIgniter 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 | APPPATH . '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 CodeIgniter controller using the Jaxon library.


class Demo extends CI_Controller
{
    public function __construct()
    {
        parent::__construct();
        // Load the Jaxon library
        $this->load->library('jaxon');
    }

    public function index()
    {
        // Register the Jaxon classes
        $this->jaxon->register();

        // Print the page
        $this->load->view('index', array(
            'JaxonCss' => $this->jaxon->css(),
            'JaxonJs' => $this->jaxon->js(),
            'JaxonScript' => $this->jaxon->script()
        ));
    }
}

The controller must inherit from the Jaxon_Controller provided in this package, and call its contructor.

Before it prints the page, the controller makes a call to $this->jaxon->register() to export the Jaxon classes. Then it calls the $this->jaxon->css(), $this->jaxon->js() and $this->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 APPPATH/jaxon/classes dir of the CodeIgniter application, and the associated namespace is \Jaxon\App.

This is a simple example of a Jaxon class, defined in the APPPATH/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 app/controllers/jaxon/Process.php file. The jaxon/process route linked by default to the Process::index() 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.

Contribute

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

License

The package is licensed under the BSD license.

  Jaxon for CodeIgniter Demo External page  
  Files folder image Files  
File Role Description
Files folder imageapp (3 directories)
Files folder imagesrc (2 files)
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  /  app  
File Role Description
Files folder imageconfig (1 file)
Files folder imagecontrollers (1 directory)
Files folder imagelibraries (1 file)

  Files folder image Files  /  app  /  config  
File Role Description
  Accessible without login Plain text file jaxon.php Aux. Auxiliary script

  Files folder image Files  /  app  /  controllers  
File Role Description
Files folder imagejaxon (1 file)

  Files folder image Files  /  app  /  controllers  /  jaxon  
File Role Description
  Accessible without login Plain text file Process.php Class Class source

  Files folder image Files  /  app  /  libraries  
File Role Description
  Accessible without login Plain text file Jaxon.php Class Class source

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

Downloadjaxon-codeigniter-2017-09-24.zip 7KB
Downloadjaxon-codeigniter-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:135
This week:1
All time:8,576
This week:586Up