lozitskiys/verse

Decorator based nano PHP framework

v0.1.4 2024-03-07 13:01 UTC

Requires

• php: ^8.0
• ext-json: *
• ext-openssl: *
• ext-pdo: *
• psr/container: ^1.0
• symfony/yaml: ^4.2

Requires (Dev)

• codeception/codeception: ^4.1
• codeception/module-asserts: ^1.3

Apache-2.0

• lozitskiys

• framework
• php

README

Example of index.php:

<?php

/** @var \Verse\Env $env */
$env = require_once __DIR__ . '/../env.php';

$user = new CurrentUser($env->pdo());

$app = 
    // App decorator
    new AppLocaleAndTz(
        // App decorator
        new AppSession(
            // Base App implementation
            new AppBase()
        )
    );

$action = 
    // Action decorator
    new ActionAuthorized(
        // Base Action implementation
        new NumbersListJson(),
        new GuestAccessLvl()
    );

$app->start($action, $env, $user);

Verse uses Action Domain Responder pattern. Example of simple action:

<?php

namespace Actions;

class NumbersListJson implements Action
{
    public function run(Env $env, User $user): Response
    {
        return new RespJson([
            'result' => 'ok',
            'list' => [1, 2, 3, 4]
        ]);
    }
}

Routing

Routes are stored in yaml file, for example:

/auth: Auth/AuthForm

/auth/process POST: Auth/AuthProcess

Each line which starts from "/" is a separate route. Default HTTP method is GET. You can define route like this:

/auth: Auth/AuthForm

or like that:

/auth GET: Auth/AuthForm

You can use tokens to retrieve variables from URI:

/blog/read/{id}: Blog/ReadPost

or even

/blog/list/{tag}/{author}: Blog/ListPosts

Use tokens in action:

class ListPosts implements Action
{
    public function run(Env $env, User $user): Response
    {
        $tag = $env->route()->token('tag');
        $author = $env->route()->token('author');
        
        return new Response\RespHtml($env->tpl()->render(
            'blog/list',
            [
                'posts' => (new BlogPosts($tag, $author))->list(),
                'tag' => $tag,
                'author' => $author
            ]
        ));
    }
}

TBA