What is TinyPHP?

TinyPHP is a fast, simple, extensible collection of PHP scripts to quickly and easily build RESTful APIs and web applications.

It provides the following functionalities:

• Routing
• REST API basic functions (Access GET and POST data, return payloads and http error codes)
• Cryptographic functions (Generate random UUIDs, nonces etc..)
• MySQL (Launch queries, get results)
• L10n (Translations via json dictionaries)
• Logging (.log files)
• Authentication (Cookie and X-Auth-Token)
• File download
• File upload
• Excel/CSV import and export
• Configuration
• Datetime (parse, format, math on dates)
• Google Captcha v3
• Input sanitization
• Email send (attachments, cc and bcc recipients)
• Stripe (payments)
• QRCodes
• Currency (format currency amounts)

Basic example

require 'tinyphp/tinyphp.php';

TinyPHP::RegisterRoute("/login", "html/login.php");
TinyPHP::Run();

Is TinyPHP a framework?

Kind of. It provides built-in functions for common tasks, but it doesn't force any folder structure nor naming conventions for you project. In that sense, TinyPHP is not really a framework like CakePHP or Laravel.

So what is it?

It's really just a set of libraries for commonly used functions, cutting down on the amount of code you have to write.

Why another collection of libraries?

I frequently find myself repeatedly writing certain functions or transferring them from one project to another. Functions that I could not find (and shouldn't be found) on regular PHP frameworks. Over the years, I've accumulated a variety of functionalities that address a wide range of API and web use cases. Ultimately, I've made the decision to centralize them on GitHub, assigning them a uniform name, something I should have done right from the beginning :-)

Why I should use it?

If you aim to swiftly create a very simple API, a straightforward web application, or a website without introducing the intricacies associated with PHP frameworks such as CakePHP and Laravel, this tool is well-suited for the task.

Requirements

TinyPHP requires PHP 7.4 or greater. Also, TinyPHP comes equipped with all necessary functionalities straight out of the box, eliminating the need for any external libraries. However, should you wish to utilize any of the additional modules such as mail, spreadsheet, stripe, or qrcodegenerator, external libraries will be required. Here's the dependency table:

TinyPHP module	External Library Required	Version
mail	PHPMailer	6.9.1
spreadsheet	PhpSpreadsheet	1.29.0
stripe	stripe-php	13.11.0
qrcodegenerator	phpqrcode	N/A

To enable a module, simply call EnableModule and pass the required module name (please see TinyPHP.php for the complete name list)

TinyPHP::EnableModule(TinyPHPmodule::CONFIG);

For modules requiring an external library

TinyPHP::EnableModule(TinyPHPmodule::MAIL, "php/vendor/PHPMailer-6.9.1");

License

TinyPHP is released under the MIT license.

Installation

1. Download the files, take the lib folder and place it in your web environment.

2. Configure your webserver.

For Apache, edit your .htaccess file with the following:

RewriteEngine On
RewriteRule ^(.*)$ index.php [QSA,L]

3. Create your index.php file.

First include TinyPHP.

require_once 'tinyphp/tinyphp.php';

Then define a route and assign a php script to handle the request. The path to the php file is relative to your index.php file.

TinyPHP::RegisterRoute("/", "html/main.php");
TinyPHP::RegisterRoute("/login", "html/login.php");

If you want, assign a 404 handler.

TinyPHP::Register404("html/404.php");

Finally, start TinyPHP.

TinyPHP::Run();

Routing

Routing in TinyPHP is done by matching a URL pattern with a php script (the controller).

TinyPHP::RegisterRoute("/login", "html/login.php");

You can specify dynamic route params in the URL (e.g. :groupid).

TinyPHP::RegisterRoute("/groups/:groupid/categories", "html/categories.php");

GetRouteParam

Gets the route param "groupid" from the URL.

TinyPHP::GetRouteParam("groupid");

Root path

If you have a common root path for all your endpoint, you can use the RegisterRoot function.

TinyPHP::RegisterRoot("/my/common/path");

Examples

Some examples.

Web application

Folder structure:

+-- demo
    |
    +-- .htaccess
    |
    +-- main.php
    |
    +-- html
    |   |
    |   +-- login.php
    |   |
    |   +-- 404.php
    |
    +-- tinyphp
        |
        +-- tinyphp.php
        |
        +-- ...

File main.php

require 'tinyphp/tinyphp.php';

TinyPHP::RegisterRoot("/demo");
TinyPHP::RegisterRoute("/", "html/dashboard.php");
TinyPHP::RegisterRoute("/login", "html/login.php");
TinyPHP::Register404("html/404.php");

TinyPHP::Run();

File .htaccess

RewriteEngine On
RewriteCond %{HTTP:X-Forwarded-Proto} !https
RewriteCond %{HTTPS} off

RewriteRule .* https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
RewriteRule ^(js|css|images)/(.*)$ demo/$1/$2 [NE,QSA,L]
RewriteRule ^/?([a-z,0-9,-,/]*)$ demo/main.php [NE,QSA,L]

# # av:php5-engine
AddHandler av-php82 .php

REST API with one endpoint (getuser)

Folder structure:

+-- api
    |
    +-- 1.0.0
    |   |
    |   +-- api.php
    |   |
    |   +-- endpoints
    |       |
    |       +-- getuser.php
    |
    +-- tinyphp
        |
        +-- tinyphp.php
        |
        +-- ...

File api.php

require '../tinyphp/tinyphp.php';

TinyPHP::RegisterRoot("/api/1.0.0");
TinyPHP::RegisterRoute("/getuser", "endpoints/getuser.php");

TinyPHP::Run();

File getuser.php

function DbErrorCallback($msg)
{
    Api::Error(500, $msg);
}

$dbConfig = (object)[
    "host" => "host",
    "name" => "dbname",
    "user" => "username",
    "pass" => "password"
];

Db::Init($dbConfig, "DbErrorCallback");

// get the userid from query string
$get = API::Get();
$userid = $get->id;

// launch the query
$res = Db::Query("SELECT * FROM users WHERE id = ?", [$userid]);

// return the results
Api::Ok($res);

Invoking the API

https://myhost/api/1.0.0/getuser?id=12

Documentation

For a comprehensive overview of modules and methods, please refer to the complete documentation.