yarf's Introduction

Yet another routing framework

A simple but powerful routing framework for PHP.

Basic usage

To create a new router responding to the root url of your server, simply do the following:

$router = new \Yarf\Router();

$classMap = [
  "" => IndexPage::class
];

$router->route($classMap);

Page types

There are three basic page types. HtmlPage, JsonPage and TextPage. Each of them is subclassable and meant to return either html, json or plain text. The content type for the http response is set appropriately.

Features

Rest support

Create a restful service with this framework is dead simple. Here is a quick example:

use Yarf\response\Response;

class UserApi extends Yarf\page\JsonPage {

  private $user;
  
  public function initialize() {
    $this->user = ...;
  }

  public function get(Response $response) {
    $response->result($this->user);
    return $response;
  }
  
  public function post(Response $response) {
    $this->user->update(...);
    $response->result($this->user);
    return $response;
  }
  
  public function delete(Response $response) {
    $response->result($this->user->delete());
    return $response;
  }

}

URI variables

When configuring your routes, route elements using a scheme like {variable} will be interpreted as variable uri parts.

use Yarf\response\Response;

class UserApi extents \Yarf\page\JsonPage {

  public function get(Response $response, $userId) {
    $response->result(UserCache::get($userId));
    return $response;
  }

}

$classMap = [
  "api" => [
    "user" => [
      "{userId}" => UserApi::class
    ]
  ]
]

$router = new Yarf\Router();
$router->route($classMap);

yarf's People

Contributors

Watchers

yarf's Issues

Potential Bug

https://github.com/jannisfink/yarf/blob/master/src/request/PageMapper.php#L86

There is the potential of a bug. I'm kind of confused with this line, I have no clear clue, what the count($uriParts) === 1 should do...

Pagemap chaining

To prevent the pagemap from becoming too large, it should be possible to chain pagemaps

Get rid of the php warnings

This is very annoying (though they are there for a reason). First ideas:

remove all the functions for responding to the requests form the superclass, so the programmer has to know which function they have to use. This would make sure that no warnings are logged, but the IDE support for auto completion does not work so well.
ignore the warnings (I don't like this)
suppress them (see above)