PHP Classes
elePHPant
Icontem

Jaxon for CakePHP: This package integrates the Jaxon library into the

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-05-19 (8 days ago) RSS 2.0 feedNot enough user ratingsTotal: 34 This week: 5All time: 8,870 This week: 144Up
Version License PHP version Categories
jaxon-cake 2.0.0BSD License5PHP 5, Libraries, AJAX
Description Author

This package integrates the Jaxon library with the Cake PHP 3 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 is available for providing paid consulting. Contact Thierry Feuzeu .
Classes: 12 packages by
Country: Cameroon Cameroon
Age: 40
All time rank: 30803 in Cameroon Cameroon
Week rank: 38 Up1 in Cameroon Cameroon Up
Innovation award
Innovation award
Nominee: 1x

Details

Jaxon Library for CakePHP

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

Features

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

Installation

First install CakePHP version 3.

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

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

Add the Jaxon plugin in the vendor/cakephp-plugins.php file.

return [
    'plugins' => [
        ...
        'Jaxon/Cake' => $baseDir . '/vendor/jaxon-php/jaxon-cake/',
    ]
];

Load the Jaxon plugin in the controller or in the bootstrap file.

Plugin::load('Jaxon/Cake', array('autoload' => true, 'routes' => true));

Load the Jaxon component in the controller.

$this->loadComponent('Jaxon/Cake.Jaxon');

Configuration

The settings in the config/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 CakePHP 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 | ROOT . '/jaxon/Controller' | 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 CakePHP controller using the Jaxon library.

namespace App\Controller;

class DemoController extends AppController
{
    public function initialize()
    {
        parent::initialize();
        // Load the Jaxon component
        $this->loadComponent('Jaxon/Cake.Jaxon');
    }

    public function index()
    {
        // Call the Jaxon module
        $this->Jaxon->register();

        $this->set('jaxonCss', $this->Jaxon->css());
        $this->set('jaxonJs', $this->Jaxon->js());
        $this->set('jaxonScript', $this->Jaxon->script());
        $this->render('demo');
    }
}

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 in the page.

The Jaxon classes

The Jaxon classes must inherit from \Jaxon\Sentry\Classes\Base. By default, they are located in the ROOT/jaxon/Classes dir of the CakePHP application, and the associated namespace is \Jaxon\App.

This is an example of a Jaxon class, defined in the ROOT/jaxon/Classes/HelloWorld.php file.

namespace Jaxon\App;

class HelloWorld extends \Jaxon\Sentry\Classes\Base
{
    public function sayHello()
    {
        $this->response->assign('div2', 'innerHTML', 'Hello World!');
        return $this->response;
    }
}

Check the jaxon-examples package for more examples.

Contribute

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

License

The package is licensed under the BSD license.

  Jaxon for CakePHP DemoExternal page  
  Files folder image Files  
File Role Description
Files folder imageconfig (2 files)
Files folder imagesrc (2 files, 1 directory)
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
  Accessible without login Plain text file routes.php Example Example script

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

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

 Version Control Unique User Downloads Download Rankings  
 100%
Total:34
This week:5
All time:8,870
This week:144Up