Recommend this page to a friend! |
Download .zip |
Info | Documentation | Demos | View files (14) | Download .zip | Reputation | Support forum | Blog | Links |
Last Updated | Ratings | Unique User Downloads | Download Rankings | |||||
2021-06-21 (2 months ago) | 54% | Total: 60 | All time: 9,956 This week: 186 |
Version | License | PHP version | Categories | |||
jaxon-zend 2.0.1 | BSD License | 5 | PHP 5, Libraries, AJAX |
Description | Author | |
This package integrates the Jaxon library with the Zend Framework 2 and 3, allowing to make AJAX calls to PHP classes. |
This package integrates the Jaxon library with the Zend Framework 2.3+ and 3.
Add the following lines in the composer.json
file, and run the composer update
command.
"require": {
"jaxon-php/jaxon-zend": "~3.1"
}
Add the Jaxon module to the modules
entry in the config/application.config.php
or config/modules.config.php
config file.
'modules' => [
'Application',
'Jaxon\Zend',
),
Edit the module/Application/config/module.config.php as follow.
1. Import the Jaxon classes into the current namespace
use Jaxon\Zend\Factory\Zf2ControllerFactory;
2. Register the Jaxon plugin with the Service Manager
'service_manager' => [
'invokables' => [
'JaxonPlugin' => 'Jaxon\Zend\Controller\Plugin\JaxonPlugin',
),
),
3. Use the provided factory to create both the application controller and the Jaxon ZF controller.
'controllers' => [
'factories' => [
'Application\Controller\Demo' => Zf2ControllerFactory::class,
'Jaxon\Zend\Controller\Jaxon' => Zf2ControllerFactory::class,
),
),
This factory injects the Jaxon plugin into the ZF controller constructor.
4. Route the Jaxon request URI to the plugin controller.
'router' => [
'routes' => [
// Route to the Jaxon request processor
'jaxon' => [
'type' => 'Zend\Mvc\Router\Http\Literal',
'options' => [
'route' => '/jaxon',
'defaults' => [
'controller' => 'Jaxon\Zend\Controller\Jaxon',
'action' => 'index',
),
),
),
),
),
Edit the module/Application/config/module.config.php file as follow.
use Jaxon\Zend\Factory\Zf3ControllerFactory;
use Jaxon\Zend\Controller\Plugin\JaxonPlugin;
use Jaxon\Zend\Controller\JaxonController;
'service_manager' => [
'invokables' => [
'JaxonPlugin' => JaxonPlugin::class,
],
],
Or
'service_manager' => [
'factories' => [
JaxonPlugin::class => InvokableFactory::class,
],
'aliases' => [
'JaxonPlugin' => JaxonPlugin::class,
],
],
'controllers' => [
'factories' => [
Controller\DemoController::class => Zf3ControllerFactory::class,
JaxonController::class => Zf3ControllerFactory::class,
],
],
This factory injects the Jaxon plugin into the ZF controller constructor.
'router' => [
'routes' => [
// Route to the Jaxon request processor
'jaxon' => [
'type' => Literal::class,
'options' => [
'route' => '/jaxon',
'defaults' => [
'controller' => JaxonController::class,
'action' => 'index',
],
],
],
],
],
The config of the Jaxon library is defined in the config/jaxon.config.php
file.
A sample config file is provided in this repo.
The settings in the config/jaxon.config.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 Zend Framework 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_dir}/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 | | | | |
This is an example of a Zend Framework controller using the Jaxon library.
namespace Application\Controller;
use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;
use Jaxon\Zend\Controller\Plugin\JaxonPlugin;
class DemoController extends AbstractActionController
{
/
* @var \Jaxon\Zend\Controller\Plugin\JaxonPlugin
*/
protected $jaxon;
public function __construct(JaxonPlugin $jaxon)
{
$this->jaxon = $jaxon;
}
public function indexAction()
{
$view = new ViewModel([
'jaxonCss' => $this->jaxon->css(),
'jaxonJs' => $this->jaxon->js(),
'jaxonScript' => $this->jaxon->script(),
]);
$view->setTemplate('demo/index');
return $view;
}
}
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 can inherit from \Jaxon\CallableClass
.
By default, they are loaded from the jaxon/Classes
dir at the root of the Zend Framework application, and the associated namespace is \Jaxon\App
.
This is a simple example of a Jaxon class, defined in the jaxon/Classes/HelloWorld.php
file.
namespace Jaxon\App;
class HelloWorld extends \Jaxon\CallableClass
{
public function sayHello()
{
$this->response->assign('div2', 'innerHTML', 'Hello World!');
return $this->response;
}
}
By default, the Jaxon request are handled by the controller in the src/Controller/JaxonController.php
file.
The /jaxon
route is linked by default to the JaxonController::actionIndex()
method.
The package is licensed under the BSD license.
Files |
File | Role | Description | ||
---|---|---|---|---|
config (1 file) | ||||
src (5 files, 2 directories) | ||||
.styleci.yml | Data | Auxiliary data | ||
composer.json | Data | Auxiliary data | ||
LICENSE | Lic. | License text | ||
README.md | Doc. | Documentation |
Files | / | src |
File | Role | Description | ||
---|---|---|---|---|
Controller (1 file, 1 directory) | ||||
Factory (2 files) | ||||
Container.php | Class | Class source | ||
Module.php | Class | Class source | ||
Session.php | Class | Class source | ||
Session.php | Class | Class source | ||
View.php | Class | Class source |
Files | / | src | / | Controller |
File | Role | Description | ||
---|---|---|---|---|
Plugin (1 file) | ||||
JaxonController.php | Class | Class source |
Files | / | src | / | Factory |
File | Role | Description |
---|---|---|
Zf2ControllerFactory.php | Class | Class source |
Zf3ControllerFactory.php | Class | Class source |
jaxon-zend-2021-06-21.zip 9KB | |
jaxon-zend-2021-06-21.tar.gz 6KB | |
Install with Composer |
Needed packages | ||
Class | Download | Why it is needed | Dependency |
---|---|---|---|
Jaxon Sentry | .zip .tar.gz | Uses the provided features | Required |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
92% |
|
|
User Ratings | ||||||||||||||||||||||||||||||
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.