ketyl/vine

This package is abandoned and no longer maintained. No replacement package was suggested.

Simple PHP framework.

dev-main 2021-12-01 05:07 UTC

Requires

• php: ^8.0|^8.1
• psr/container: ^2.0

Requires (Dev)

• phpstan/phpstan: ^0.12
• phpunit/phpunit: ^9.5
• symfony/var-dumper: ^5.3

MIT

• Zak Nesler

• framework

README

Vine is a simple PHP 8 micro-framework, written from the ground-up. This is more of a learning experience for me and is not intended to be production-ready, nor is it going to be in the future.

Inspired by popular PHP frameworks such as Laravel and Slim, Vine maintains a focus on developer experience. Its API is designed to be simple, intuitive, and consistent, all while using as little "magic" as possible.

Features

• Flexible routing engine
• Service container
• Basic view support
• Basic middleware support
• Multiple return types

Roadmap

• Dependency injection
• Basic templating engine
• Adherence to PSR standards (routing, middleware, etc.)

Installation

The installation of Vine is like any other composer package. First, include the package as a dependency:

composer require ketyl/vine

Once installed, you may create an instance of Ketyl\Vine\App, add your routes, and run the application:

// Create a new application instance
$app = new App();
$router = $app->router();

// Add global middleware
$router->addMiddleware(function (Request $request, Response $response, $next) {
    $response->write('BEFORE');
    $response = $next($request, $response);
    $response->write('AFTER');

    return $response;
});

// Anonymous function
$router->get('/', fn () => 'Hello, world!');

// Adding route-specific middleware
$router->get('/', fn () => 'Hello, world!')
    ->addMiddleware(function (Request $request, Response $response, $next) {
        $response->write('BEFORE');
        $response = $next($request, $response);
        $response->write('AFTER');

        return $response;
    });

// Class-based route using a method
$router->get('/posts', [PostController::class, 'index']);

// Class-based route using __invoke
$router->get('/download', DownloadController::class);

// Route parameters
$router->get('/param/{foo}', fn ($foo) => $foo);

// Route parameters with RegEx restriction
$router->get('/regex-a/{foo:\d+}', fn ($foo) => $foo);

// Basic RegEx restriction
$router->get('/regex-b/\d+', fn ($foo) => $foo);

// Return a view
$router->get('/view', fn () => view(__DIR__ . '/../views/index.html'));

// Attempt to match the request's URI with the registered routes
$app->run();