README

Teensy PHP is a micro web framework for rapidly creating REST APIs and hypermedia.

Project Status

Features

Lightweight Framework
Simple Router
PHP Templating Engine
Middleware Support
Easy to inject or replace functionality (its just some small functions)
env Config Utility
Database Connection Manager Utility
ArrayAccessImplementation, Crud Traits

Examples

<?php
// routes/web.php
use App\Actions\Home\DisplayHome;

routerGroup("/", function () {
    // Homepage
    route(method(GET), url_path('/'), DisplayHome::class);

    // Example url parameter
    route(method(GET), url_path_params("/hello/:name"), function () {
        render(200, html_out(template('src/templates/hello.php', ['name' => $_GET[':name']])));
    });
});

<?php
// routes/api.php

// /api/{route}
routerGroup("/api", function () {
    // API home
    route(method("GET"), url_path("/"), function () {
        render(200, json_out(["message" => "Hello World!"]));
    });

    // Example JSON body (echo server)
    route(method(POST), url_path("/echo"), function () {
        $body = json_in();
        render(201, json_out($body));
    });
});

<?php
// App/Actions/Home/DisplayHome.php
namespace App\Actions\Home;

class DisplayHome
{
    public function __invoke()
    {
        $accept = request_header('Accept');
        if ($accept === 'application/json') {
            render(200, json_out(['message' => 'Hello World']));
        } else {
            render(200, html_out(template(app_root() . "/templates/pages/home.php", [])));
        }
    }
}

Requirements

PHP 8.0+
Composer

Documentation

Please see the wiki for more information on how to rapidly create apps with teensyphp.

Creating a new project

Install teensyphp command line tool

composer global require daniel-samson/teensyphp

Create a new project

teensyphp new project-name
cd project-name
composer install

Start buit in web server

composer dev

open web route http://localhost:8000
open api route http://localhost:8000/api

Update Teensyphp

composer global update

Background

This project was an exploration of Object Oriented Programming vs Procedural / Structure Programming. At the time (2012), composer autoloading only worked for classes. I asked the question "What if functions were first class like they are in JS/Haskel?". At the time, classes seem to take up more overhead eg. more memory and cpu time. However, functions didn't seem to have this penalty. This was partly to do with how the autoloader worked (which improved over time). I also was wanting to change how projects that were OO worked. I didn't like facades. I liked having simple higher order functions that i could replace with my own implementations. TeensyPHP explored what it would be like to just use functions. however, as it grew, I needed to manage database connections. So i introduced entities, a environment config manager and a database manager.

Everything in TeensyPHP is completely replaceable!

daniel-samson / teensyphp

Maintainers

Details