README

A simple, drop-in PHP routing soloution.

Easy to call routes
Supports URL variables

Installation

You're required to have PHP 5.4 or higher due to the use of short arrays. The first way you can install is via including src/routes.php, although I don't recommend this. The second way is via composer:

composer require luket/php-router dev-master
composer update

Usage

Currently, use is fairly limited, but it gets the job done.

GET Requests

Router::GET("/home", ["name" => "ACosmeticName", "function" => "showHome"]);

The first paramater is the URI you want to be called on, function is the function that you want to be called. Alternativly you can use:

Router::GET("/home", ["name" => "ACosmeticName", "controller" => "StaticPages@showAbout"]);

Which will call showAbout on the StaticPages class.

#####POST Requests

Post requests accept the same paramaters, accept they will only respond to a POST reqeust.

Router::POST("/home", "controller" => "StaticController@handleHome");

In the future I may support PUT, DELETE, UPDATE etc.

URL Paramaters

This also accepts URL paramates, so for instance http://example/enable/1001 would be:

Router::GET("/[:alpha]/[:int]", ["function" => "doStuff()"]);

Currently accepted:

URI	Desc	Regex
[:int]	Only allows an Interger as the paramater	([a-zA-Z]+)
[:alpha]	Allows any alpha-numberic string, including a-Z, A-Z and 0-9	([0-9]+)
[:string]	Allows only letters (a-z, A-Z)	([a-zA-Z0-9-_]+)

Make it work

Oh,Theres one thing you need to do to make it actually route.

Router::run();

and thats all there is too it!

License

The MIT License (MIT)

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.

luket / php-router

Maintainers

Details