Welcome to Road Trip’s documentation!¶
Note
This documentation is not yet finished, and the code is not finished either, so actually nothing is finished and I should work harder and now I’m going to do something productive instead of writing this useless note.
Overview¶
Requirements¶
- PHP 7.1 or higher
- If you use Apache, you will need the
mod_rewritemodule. - You will need to redirect all requests that do not lead to existing files to your index file, most of the times this
is the
index.phpfile in your public root.
Installation¶
The recommended way to install Road Trip is with Composer.
You can install Road Trip by using the Composer CLI.
composer require stevenliebregt/road-trip:^1.0
Alternatively you can add the dependency to your existing composer.json file.
{
"require": {
"stevenliebregt/road-trip": "^1.0"
}
}
After installing it, you need to require Composer’s autoloader in your code.
License¶
This project is licensed using the MIT license.
Copyright (c) 2018 Steven Liebregt
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Quickstart¶
This page provides a quick introduction to Road Trip, and shows some examples. If you have not installed Road Trip yet,
please head over to the overview page.
Basic example¶
This basic example will get you started right away.
<?php
use StevenLiebregt\RoadTrip\RouteCollection;
use StevenLiebregt\RoadTrip\Router;
$router = new Router();
$collection = new RouteCollection();
$collection->get('/products', 'ProductController.index');
$collection->post('/products', 'ProductController.create');
$router->addCollection($collection);
$router->compile();
$match = $router->match('THE_CURRENT_REQUEST_METHOD', 'THE_CURRENT_REQUEST_URI');
Setting options and prefixes¶
This example will show you how to set prefixes for path, names and handlers, and how you can set options.
<?php
use StevenLiebregt\RoadTrip\RouteCollection;
use StevenLiebregt\RoadTrip\Router;
$router = new Router();
$collection = new RouteCollection();
$collection->setPathPrefix('/api');
$collection->get('/foo', 'Foo.Action'); // The prefix resolves this to `/api/foo`.
$router->addCollection($collection);
$router->compile();
$match = $router->match('THE_CURRENT_REQUEST_METHOD', 'THE_CURRENT_REQUEST_URI');
Loading multiple collections¶
TODO
Loading collections from files¶
TODO
Caching routes¶
TODO