jaxon-php / jaxon-laravel
Jaxon library integration for the Laravel framework
Installs: 1 130
Dependents: 1
Suggesters: 0
Security: 0
Stars: 8
Watchers: 3
Forks: 1
Open Issues: 0
Requires
- illuminate/support: 6.*|7.*|8.*|9.*|10.*
- jaxon-php/jaxon-core: ^4.0
Provides
- dev-main
- v4.x-dev
- v4.1.0
- v4.0.2
- v4.0.1
- v4.0.0
- v4.0-rc.1
- v4.0-beta.1
- v3.2.x-dev
- v3.2.1
- v3.2.0
- v3.1.0
- v3.0.4
- v3.0.3
- v3.0.2
- v3.0.1
- v3.0.0
- v3.0-beta.2
- v3.0-beta.1
- v2.0.2
- v2.0.1
- v2.0.0
- v2.0-beta.9
- v2.0-beta.8
- v2.0-beta.7
- v2.0-beta.6
- v2.0-beta.5
- v2.0-beta.4
- v2.0-beta.3
- v2.0-beta.2
- v2.0-beta.1
- v1.0.7
- v1.0.6
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
This package is auto-updated.
Last update: 2024-10-28 19:29:39 UTC
README
This package integrates the Jaxon library into the Laravel framework. It works with Laravel version 7 or newer.
Installation
Add the following lines in the composer.json
file, and run the composer update
command.
"require": { "jaxon-php/jaxon-laravel": "^5.0" }
Publish the package configuration.
php artisan vendor:publish --tag=config
Routing and middlewares
The library automatically registers two middlewares, jaxon.config
and, 'jaxon.ajax'.
The jaxon.config
middleware must be added to the routes to pages that need to show Jaxon related content.
Route::get('/', [DemoController::class, 'index'])->name('demo')->middleware(['web', 'jaxon.config']);
It can also be configured to register its route and the associated middlewares by adding the route
and middlewares
options in the config/jaxon.php
file.
'app' => [ 'request' => [ 'route' => 'jaxon', 'middlewares' => ['web'], ], ],
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 Laravel application.
The following options can be defined in the app
section of the config file.
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.
The route
option is overriden by the core.request.uri
option of the Jaxon library.
Usage
Insert Jaxon js and css codes in the pages that need to show Jaxon related content, using the Blade
functions provided by the Jaxon package.
class DemoController extends Controller { public function index() { // Print the page return view('demo/index', [ 'pageTitle' => "Laravel Framework", ]); } }
// resources/views/demo/index.blade.php <!-- In page header --> @jxnCss() </head> <body> <!-- Page content here --> </body> <!-- In page footer --> @jxnJs() @jxnScript()
The Jaxon classes
The Jaxon classes can inherit from \Jaxon\App\CallableClass
.
By default, they are located in the app/Jaxon/App
dir of the Laravel application, and the associated namespace is \Jaxon\App
.
This is a simple example of a Jaxon class, defined in the app/Jaxon/App/HelloWorld.php
file.
namespace Jaxon\App; class HelloWorld extends \Jaxon\App\CallableClass { public function sayHello() { $this->response->assign('div2', 'innerHTML', 'Hello World!'); return $this->response; } }
Contribute
- Issue Tracker: github.com/jaxon-php/jaxon-laravel/issues
- Source Code: github.com/jaxon-php/jaxon-laravel
License
The package is licensed under the BSD license.