Turbo
Turbolinks but for your PHP application; powered by PJAX., (*1)
, (*2)
Installation
Turbo has only been tested installing through Composer., (*3)
Add rcrowe\turbo
as a requirement to composer.json:, (*4)
{
"require": {
"rcrowe/turbo": "0.2.*"
}
}
Update your packages with composer update
or install with composer install
., (*5)
Providers
Providers enable instant usage of Turbo within different frameworks, we currently provide the following integrations:, (*6)
Laravel, (*7)
Add Turbo\Provider\Laravel\TurboServiceProvider
to app/config/app.php
and your good to go., (*8)
The Laravel provider also registers a turbo.pjax
event so that other parts of your app can listen for a pjax request. For example:, (*9)
Event::listen('turbo.pjax', function($request, $response) {
$response->header('X-App-Msg', 'Hello world');
});
Fuelphp, (*10)
Add class_alias('Turbo\\Provider\\Fuel\\Response', 'Response')
to the bottom of fuel\app\bootstrap.php
and your good to go., (*11)
Turbo also registers a turbo.pjax
event that you can listen for. For example:, (*12)
Event::register('turbo.pjax', function() {
echo 'This is a pjax request';
});
PJAX
To make this all work Turbo needs PJAX to get and set the response.
Just like Turbolinks we respond with the whole body, not just a section of it. In order to support this, you need
to setup PJAX to use the <body>
tag. A simple example of this would be:, (*13)
$(function() {
$(document).pjax('.js-pjax', 'body');
});
License
Turbo is released under the MIT public license., (*14)