eric-chau/jarvis

Jarvis is a PHP 7.1 micro-framework

Jarvis, a PHP 7.1 micro framework

, _(*1)

Jarvis is a PHP 7.1 micro framework. It is designed to be simple and lightweight., _(*2)

Note that if you want to use Jarvis with PHP 5.6, please switch on 0.1 branch or use the v0.1.* tag., _(*3)

Jarvis requires php >= 7.1. it's based on its own dependency injection container, http foundation component from Symfony and nikic's fast route., _(*4)

Usage

<?php

require_once __DIR__ . '/vendor/autoload.php';

$jarvis = new Jarvis\Jarvis();

$jarvis->router
    ->beginRoute('default')
        ->setMethod('get')
        ->setPattern('/')
        ->setHandler(function () {
            return 'Hello world!';
        })
    ->end()
;

$response = $jarvis->run();

$response->send();

How Jarvis process incoming request

The schema below will sum up how Jarvis\Jarvis::run() treats any incoming request:, _(*5)

INPUT: an instance of Request

|
|__ Step 1: broadcast RunEvent.
|
|__ Step 2: check if RunEvent has a response?
|_______
| NO    | YES
|       |
|       |_ RETURN Response
|
|__ Step 3: resolve URI
|
|__ Step 4: does request match any route?
|_______
| NO*   | YES
|       |
|       |_ Step 4a: broadcast ControllerEvent
|       |
|       |_ Step 4b: invoke callback to process the request
|       |
|<------
|
|_ Step 5: broadcast ResponseEvent
|
|_ RETURN Response

OUT: an instance of Response

*: note that if provided URI does not match any route run() will return an instance of Response with 404 or 406 status code., _(*6)

Router skill

Jarvis' Router can handle anonymous and named routes. By default, a route is type of HTTP GET method and the pattern setted to /. You can find some example below:, _(*7)

Anonymous route, GET HTTP method, / as pattern

<?php

require_once __DIR__ . '/vendor/autoload.php';

$jarvis = new Jarvis\Jarvis();

$jarvis->router
    ->beginRoute()
        ->setHandler(function () {
            return 'foobar!';
        })
    ->end()
;

Named route, name: user_edit , http method: PUT, pattern: /user/{id}

Note that id must be a number. Let's see how to do so., _(*8)

<?php

require_once __DIR__ . '/vendor/autoload.php';

$jarvis = new Jarvis\Jarvis();

$jarvis->router
    ->beginRoute('user_edit')
        ->setMethod('PUT')
        ->setPattern('/user/{id:\d+}')
        ->setHandler(function ($id) {
            // Do some stuff

            return "User $id informations are now up-to-date!";
        })
    ->end()
;

echo $jarvis->router->uri('user_edit', ['id' => 123]); // print '/user/123'

Dependency injection container skill

Container::alias()

Jarvis' DIC (dependency injection container) can deal with alias:, _(*9)

<?php

$jarvis = new Jarvis\Jarvis();

$jarvis['foo'] = 'hello world';
$jarvis->alias('bar', 'foo');

$jarvis['foo'] === $jarvis['bar']; // = true

Container::find()

::find() is an another useful method provided by Jarvis' DIC:, _(*10)

<?php

$jarvis = new Jarvis\Jarvis();

$jarvis['dicaprio_movie_1997'] = 'Titanic';
$jarvis['dicaprio_movie_2010'] = 'Inception';
$jarvis['dicaprio_movie_2014'] = 'The Wolf of Wall Street';

$jarvis->find('dicaprio_movie_*'); // = ['Titanic', 'Inception', 'The Wolf of Wall Street']
$jarvis->find('dicaprio_movie_19*'); // = ['Titanic']
$jarvis->find('dicaprio_movie_2015'); // = []