2017 © Pedro Peláez
 

library hack-router

URI routing for Hack

image

fredemmott/hack-router

URI routing for Hack

  • Saturday, November 5, 2016
  • by fredemmott
  • Repository
  • 3 Watchers
  • 2 Stars
  • 269 Installations
  • Hack
  • 1 Dependents
  • 0 Suggesters
  • 2 Forks
  • 2 Open issues
  • 9 Versions
  • 0 % Grown

The README.md

Hack-Router Build Status

Fast, type-safe request routing, parameter retrieval, and link generation, with PSR-7 support., (*1)

Components

HTTP Exceptions

Exception classes representing common situations in HTTP applications: - InternalServerError - MethodNotAllowed - NotFoundException, (*2)

BaseRouter

A simple typed request router. Example:, (*3)

<?hh // strict
/** TResponder can be whatever you want; in this case, it's a
 * callable, but classname<MyWebControllerBase> is also a
 * common choice.
 */
type TResponder = (function(ImmMap<string, string>):string);

final class BaseRouterExample extends BaseRouter<TResponder> {
  protected function getRoutes(
  ): ImmMap<HttpMethod, ImmMap<string, TResponder>> {
    return ImmMap {
      HttpMethod::GET => ImmMap {
        '/' =>
          ($_params) ==> 'Hello, world',
        '/user/{user_name}' =>
          ($params) ==> 'Hello, '.$params['user_name'],
      },
      HttpMethod::POST => ImmMap {
        '/' => ($_params) ==> 'Hello, POST world',
      },
    };
  }
}

Simplified for conciseness - see examples/BaseRouterExample.php for full executable example., (*4)

UriPatterns

Generate FastRoute fragments, URIs (for linking), and retrieve URI parameters in a consistent and type-safe way:, (*5)

<?hh // strict
final class UserPageController extends WebController {
  public static function getUriPattern(): UriPattern {
    return (new UriPattern())
      ->literal('/users/')
      ->string('user_name');
  }
  // ...
}

Parameters can be retrevied, with types checked at runtime both against the values, and the definition:, (*6)

public function getResponse(): string {
  return 'Hello, '.$this->getUriParameters()->getString('user_name');
}

You can also generate links to controllers:, (*7)

$link = UserPageController::getUriBuilder()
  ->setString('user_name', 'Mr Hankey')
  ->getPath();

These examples are simplified for conciseness - see examples/UriPatternsExample.php for full executable example., (*8)

Codegen

The hhvm/hack-router-codegen project builds on top of of this project to automatically generate:, (*9)

  • Full request routing objects and URI maps based on UriPatterns defined in the controllers
  • Per-controller parameter classes, allowing $params->getFoo() instead of $params->getString('Foo'); this allows the typechecker to catch more errors, and IDE autocomplete functionality to support parameters.
  • Per-controller UriBuilder classes, with similar benefits

Contributing

We welcome GitHub issues and pull requests - please see CONTRIBUTING.md for details., (*10)

License

hack-router is MIT-licensed., (*11)

The Versions

05/11 2016

dev-master

9999999-dev https://github.com/fredemmott/hack-router

URI routing for Hack

  Sources   Download

The Requires

 

The Development Requires

hack hhvm routing router

03/10 2016

v1.0.0rc7

1.0.0.0-RC7 https://github.com/fredemmott/hack-router

URI routing for Hack

  Sources   Download

The Requires

 

The Development Requires

hack hhvm routing router

02/10 2016

v1.0.0rc6

1.0.0.0-RC6 https://github.com/fredemmott/hack-router

URI routing for Hack

  Sources   Download

The Requires

 

The Development Requires

hack hhvm routing router

25/09 2016

v1.0.0rc5

1.0.0.0-RC5 https://github.com/fredemmott/hack-router

URI routing for Hack

  Sources   Download

The Requires

 

The Development Requires

hack hhvm routing router

25/09 2016

v1.0.0rc4

1.0.0.0-RC4 https://github.com/fredemmott/hack-router

URI routing for Hack

  Sources   Download

The Requires

 

The Development Requires

hack hhvm routing router

24/09 2016

v1.0.0rc3

1.0.0.0-RC3 https://github.com/fredemmott/hack-router

URI routing for Hack

  Sources   Download

The Requires

 

The Development Requires

hack hhvm routing router

19/09 2016

v1.0.0rc2

1.0.0.0-RC2 https://github.com/fredemmott/hack-router

URI routing for Hack

  Sources   Download

The Requires

 

The Development Requires

hack hhvm routing router

19/09 2016

v1.0rc1

1.0.0.0-RC1 https://github.com/fredemmott/hack-router

URI routing for Hack

  Sources   Download

The Requires

 

The Development Requires

hack hhvm routing router

16/12 2015

dev-legacy-pre-2015-12-20

dev-legacy-pre-2015-12-20 https://github.com/fredemmott/hack-router

URI map generator for Hack

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm urimap