netherphp/avenue

A Request Router.

v4.0.3 2022-02-22 16:43 UTC

README

Nether Avenue

Packagist Build Status codecov

A PHP 8+ annotation based request router. It is able to scan through a directory of routes/controllers and determine which ones should get executed to satisfy incoming request.

Routes are able to define via the RouteHandler attribute, the path, domain, and HTTP verb they are willing to answer. They can also extract information from the URI and pass them to the method. It will make sure the data is of the types declared on the method signature.

Routes are checked if they can handle a request based on the request parameters (Verb, Domain, and Path). Then routes are asked if they will handle a request. A method just for checking the willingness of a route handler can be defined with the ConfirmWillAnswerRequest attribute.

The Router is able to both scan a directory on the fly to generate the route map (nice for development), as well as there is a vendor bin script, netherave, which is able to generate a static route map file that the Router will load to speed things up.

Quickstart

How-To on getting the library up and running on a fresh project.

Documentation

All documentation that exists is currently on the GitHub wiki.

Example Router (www\index.php)

require('vendor/autoload.php');

$Config = Nether\Avenue\Library::PrepareDefaultConfig();
$Router = new Nether\Avenue\Router($Config);
$Router->Run();

Example Route (routes\Home.php)

namespace Routes;

use Nether\Avenue;

class Home
extends Avenue\Route {

	#[Avenue\Meta\RouteHandler('/index')]
	public function
	Index():
	void {

		echo 'Home Page.';
		return;
	}

	#[Avenue\Meta\RouteHandler('/dashboard')]
	#[Avenue\Meta\ConfirmWillAnswerRequest]
	public function
	Dashboard():
	void {

		echo 'User Dashboard.';
		return;
	}

	public function
	DashboardWillAnswerRequest():
	int {

		$User = YourAppSessionLib::GetCurrentUser();

		if($User && $User->CanHasDashboard())
		return Avenue\Response::CodeOK;

		return Avenue\Response::CodeForbidden;
	}

	#[Avenue\Meta\ErrorHandler(403)]
	public function
	HandleForbidden():
	void {

		echo "Dude No.";
		return;
	}

	#[Avenue\Meta\ErrorHandler(404)]
	public function
	HandleNotFound():
	void {

		echo "Bruh Wut?";
		return;
	}


}

Example Static Map Generation (CLI)

$ netherave gen routes --show
Route Directory: routes
Route File: ./routes.phson

Summary:
 * GET (2)
   Routes\Home::Index
   Routes\Home::Dashboard

 * Error Handlers (2)
   Routes\Home::HandleForbidden
   Routes\Home::HandleNotFound

Notes

This is not a PSR compliant anything. It do as it be.