lausek/lowebf

lausek's own web framework

lowebf's Issues

New module for accessing predefined constants

Idea: Provide functionality for reading and converting superglobal values.

// version 1
$pageId = $env->variables()->get()->getAsInteger("pageId")->unwrapOr(1);

// version 2
$pageId = $env->variables()->get()->asInteger("pageId")->unwrapOr(1);

// version 3
$pageId = $env->variables()->get("pageId")->mapToInteger()->unwrapOr(1);

Alternative Names

• superglobals
• predefined
• globals

Mockup

class VariableModule extends Module {
    // $_GET variable
    public function get() -> Array;
    // $_POST variable
    public function post() -> Array;
    // $_SERVER variable
    public function server() -> Array;
}

class Array {
    public static function from(array &$data) : Array;
    public function getAsInteger(string $name) : Result<int>;
    public function getAsFloat(string $name) : Result<float>;
    // ...
}

Move documentation to own branch

Cloning the repository takes way too long because of the newly added documentation directory.

Add Result Type for handling Exceptions

Idea: Introduce a new class for wrapping up operation results or errors like a sum type.

Old code:

$env = lowebf\Environment::getInstance();
// will throw an exception
$posts = $env->posts()->loadPage(null);
// ...

New code:

$env = lowebf\Environment::getInstance();
// throws an exception like previous example
$posts = $env->posts()->loadPage(null)->unwrap();
// returns the result if found or exits script if not
$posts = $env->posts()->loadPage(null)->unwrapOrExit($env);
// ...

$env->listDirectory(null)
        ->mapOk(function ($folders) {
            // ... do something with folders ...
            return $folders;
        });

Mockup

class Result {
    const OK_STATE = 1;
    const ERROR_STATE = 2;

    /** @var int */
    private $state;
    private $argument;

    private function __construct(int $state, $argument);

    public static function ok($value) : Result;

    public static function error(Exception $e) : Result;

    public function isOk() : bool;

    public function isError() : bool;

    // try to return operations result.
    // throws exception if result is not successful.
    public function unwrap();

    // unwrap the result or use default
    public function unwrapOr($default);

    // clear output buffer and set status code
    public function unwrapOrExit(Environment $env, $statusCode = null);
   
    // if the result is ok -> pass it to $mapper and wrap it in a new result.
    // returns itself otherwise.
    public function mapOk(callable $mapper) : Result;
}

Make attribute access from configuration easier

Add new method to ConfigModule for reading nested attributes.

Example

Expected output:

• $env->config()->getNested("site.db") should return ["host": "localhost"].
• $env->config()->getNested("site.db.host") should return localhost.

site:
    db:
        host: "localhost"

Gallery-Feature

Requirements:

• Save images as a group at a deterministic location
• Support fixed creation date (do not rely on filemtime)
• List available galleries by date (descending)
• Associate Posts with Galleries.

Concept:

• Save galleries at /data/galleries/<year>-<month>-<day>-<title>/...
• New GalleryModule
  • load, loadOrCreate, loadGalleries
• New data class Gallery
  • $date
  • $title
  • $items (image or video)
  • save
  • FUTURE: add, remove
• Post now has an attribute gallery that stores the associated gallery id.
  • getGallery() : ?Gallery