pedrofaria/hope

Hope microframework

Hope

Hope is a very lightweight PHP microframework., _(*1)

Check a example of Hope application, _(*2)

Installation

TODO!, _(*3)

Usage

Very simple usage of Hope microframework., _(*4)

$app = new Hope\Application;

$app->setRoute(function(Hope\Router\RouteCollector $route) {
    $route->add('GET', '/ping', function() {
        return ['data' => 'pong'];
    });
});

$app->bootstrap();
$app->run();

And that's it!, _(*5)

Routes

All routes are defined with the method setRoute. You can pass a closure (above) or a file name with the route definition., _(*6)

Map all your routes to your actions., _(*7)

$route->add(METHOD, URI, ACTION);

If you want to map more than one method to the same action, use:, _(*8)

$route->add([METHOD1, METHOD2], URI, ACTION);

You can define parameters on URI using braces. Example:, _(*9)

/recipes/{id}

Now the parameter id will be passed to your controller action. You can also specify an regular expression to your parameter to have a better controls of your URIs, example:, _(*10)

/recipes/{id:\d+}

Your actions should be defined as string, array or closures. example:, _(*11)

$route->add('GET', '/recipes', 'App\Controller\RecipesController::index');
$route->add('GET', '/recipes', ['App\Controller\RecipesController', 'index']);
$route->add('GET', '/ping', function () {
    return 'pong';
};

Additionally, you can specify routes inside of a group. All routes defined inside a group will have a common prefix., _(*12)

For example, defining your routes as:, _(*13)

$route->addGroup('/admin', function (Hope\Router\RouteCollector $route) {
    $route->add('GET', '/do-something', 'handler');
    $route->add('GET', '/do-another-thing', 'handler');
    $route->add('GET', '/do-something-else', 'handler');
});

Will have the same result as:, _(*14)

$route->add('GET', '/admin/do-something', 'handler');
$route->add('GET', '/admin/do-another-thing', 'handler');
$route->add('GET', '/admin/do-something-else', 'handler');

Nested groups are also supported, in which case the prefixes of all the nested groups are combined., _(*15)

For more informations, access https://github.com/pedrofaria/router, _(*16)

Providers

You can extends or replace some funcionality of Hope using the Dependency Injection system. Just two steps and every thing is running., _(*17)

1) Create your own Provider., _(*18)

<?php
namespace App\Providers;

class MyRequestProvider implements Hope\Contracts\ProviderInterface
{
    public static function register(Hope\Application $app)
    {
        $app->bind('Hope\Http\Request', function() {
            return new App\Http\MyRequest();
        });
    }
}

2) Add it with the method addExternalProviders., _(*19)

$app->addExternalProviders([
    App\Providers\YourProviderClassProvider::class,
]);

CAUTION: This method must stay before bootstrap()., _(*20)

Running Tests

Codeception was chosen on this project to support all tests. To run, use the command below:, _(*21)

$ vendor/bin/codecept run unit, _(*22)

If you want run with code coverage, use the follow command and the HTML report will be available at tests/_output/coverage., _(*23)

$ vendor/bin/codecept run unit --coverage --coverage-html, _(*24)