README

Leaf Router

Leaf router is the core routing engine which powers the Leaf PHP framework. Leaf router is now served as a serve-yourself module which can even be used outside the Leaf ecosystem.

Leaf Router is still built into Leaf Core and doesn't need to be installed separately.

Installation

You can easily install Leaf using Composer.

composer require leafs/router

Basic Usage

If you are using leaf router with Leaf, you can build your leaf apps just as you've always done:

<?php
require __DIR__ . "vendor/autoload.php";

// GET example
app()->get("/", function () {
  response()->json([
    "message" => "Welcome!"
  ]);
});

// MATCH example
app()->match("GET", "/test", function () {
  response()->json([
    "message" => "Test!"
  ]);
});

app()->run();

If however, you are using leaf router outside of the leaf framework, you simply need to call these methods on the Leaf\Router object:

<?php

use Leaf\Router;

require __DIR__ . "vendor/autoload.php";

// GET example
Router::get("/", function () {
  echo json_encode([
    "message" => "Welcome!"
  ]);
});

// MATCH example
Router::match("GET", "/test", function () {
  echo json_encode([
    "message" => "Test!"
  ]);
});

Router::run();

You may quickly test this using the built-in PHP server:

php -S localhost:8000

💬 Stay In Touch

📓 Learning Leaf 3

Leaf has a very easy to understand documentation which contains information on all operations in Leaf.
You can also check out our youtube channel which has video tutorials on different topics
We are also working on codelabs which will bring hands-on tutorials you can follow and contribute to.

😇 Contributing

We are glad to have you. All contributions are welcome! To get started, familiarize yourself with our contribution guide and you'll be ready to make your first pull request 🚀.

To report a security vulnerability, you can reach out to @mychidarko or @leafphp on twitter. We will coordinate the fix and eventually commit the solution in this project.

Code contributors

🤩 Sponsoring Leaf

Your cash contributions go a long way to help us make Leaf even better for you. You can sponsor Leaf and any of our packages on open collective or check the contribution page for a list of ways to contribute.

And to all our existing cash/code contributors, we love you all ❤️

leafs / router

Maintainers

Details