project inphinit

inphinit/inphinit

A framework for easy creation of routes

• Installing
• Testing
• NGINX
• Folder structure
• Creating routes
• Grouping routes
• Route and URL patterns
• Documentation

Installing

Requirements:, _(*1)

1. Currently supported PHP version: https://www.php.net/supported-versions.php.
   • Minimal _PHP 5.4_ (backward compatibility is maintained for users with upgrade limitations).
   • If you need a full-featured server for Windows or macOS, try: Wamp, Xampp, Laragon, EasyPHP, AMPPS, etc.
2. (Optional) Intl PHP extension to use Inphinit\Utility\Strings class.
3. (Optional) COM PHP extension or cURL PHP extension to use Inphinit\Filesystem\Size class.

After installing PHP, you can install Inphinit using Composer or Git., _(*2)

If you use composer, run the command (more details in https://getcomposer.org/doc/03-cli.md):, _(*3)

php composer.phar create-project inphinit/inphinit my-application

If you use composer global, run the command:, _(*4)

composer create-project inphinit/inphinit my-application

Installing using Git:, _(*5)

git clone --recurse-submodules https://github.com/inphinit/inphinit.git my-application
cd my-application

Testing

After navigating to the folder you must execute the following command, if you want to use PHP built-in web server:, _(*6)

php -S localhost:5000 -t public index.php

And access in your browser http://localhost:5000/, _(*7)

NGINX

If you want to experiment with a web server such as NGINX, you can use the following example to configure your nginx.conf:, _(*8)

location / {
    root /home/foo/bar/my-application;

    # Redirect page errors to route system
    error_page 403 /index.php/RESERVED.INPHINIT-403.html;
    error_page 500 /index.php/RESERVED.INPHINIT-500.html;

    try_files /public$uri /index.php?$query_string;

    location = / {
        try_files $uri /index.php?$query_string;
    }

    location ~ /\. {
        try_files /index.php$uri /index.php?$query_string;
    }

    location ~ \.php$ {
        # Replace by your FPM or FastCGI
        fastcgi_pass 127.0.0.1:9000;

        fastcgi_index index.php;
        include fastcgi_params;

        set $teeny_suffix "";

        if ($uri != "/index.php") {
            set $teeny_suffix "/public";
        }

        fastcgi_param SCRIPT_FILENAME $realpath_root$teeny_suffix$fastcgi_script_name;
    }
}

Note: For FPM use fastcgi_pass unix:/var/run/php/php<version>-fpm.sock (replace <version> by PHP version in your server), _(*9)

Folder structure

├───.htaccess                  # Apache web server configuration for the application
├───index.php                  # Only modify the values of existing constants, and only if necessary
├───server                     # Shortcut to start the built-in web server on Linux and macOS
├───server.bat                 # Shortcut to start the built-in web server on Windows
├───web.config                 # IIS web server configuration for the application
├───public/                    # This folder can hold static files or PHP scripts that run independently of the main application
│   └───.htaccess              # Apache web server configuration for additional PHP scripts and static files
└───system/                    # Folder containing your application code
    ├───dev.php                # Similar to main.php, but only used in development mode
    ├───errors.php             # Should define error page behavior (e.g., 404 or 405 errors), allowing static files or views to be served
    ├───main.php               # The main file for defining routes and events, available in both development and production modes
    ├───boot/                  # Contains settings for inphinit_autoload, similar to composer_autoload
    │   ├───importpackages.php #
    │   └───namespaces.php     #
    ├───configs/               # Contain varied configuration files, it is recommended that you do not version this folder
    │   ├───app.php            # Don't add new keys, just change the values of existing ones if necessary
    │   └───debug.php          # Don't add new keys, just change the values of existing ones if necessary
    ├───Controllers/           # Must contain the classes that will be controllers used in the routes
    ├───storage/               #
    ├───vendor/                # Contain third-party packages and the framework
    └───views/                 # Should contain your views

In development mode, the system/dev.php script will always be executed first, then system/main.php will be executed, and if an error occurs, such as 404 or 405, the last script to be executed will be system/errors.php, _(*10)

Creating routes

To create a new route, edit the system/main.php file, if you want the route to only be available in development mode, then edit the system/dev.php file., _(*11)

The route system supports controllers, callables and anonymous functions, examples:, _(*12)

<?php

// anonymous functions
$app->action('GET', '/closure', function () {
    return 'Hello "closure"!';
});

function foobar() {
    return 'Hello "function"!';
}

// callable function
$app->action('GET', '/function', 'foobar');

// callable class static method (Note: autoload will include the file)
$app->action('GET', '/class-static-method', ['MyNameSpace\Foo\Bar', 'hello']);

// callable class method
$foo = new Sample;
$app->action('GET', '/class-method', [$foo, 'hello']);


// do not add the Controllers prefix, the framework itself will add
$app->action('GET', '/controller', 'Boo\Bar::xyz');

/**
 * Controller from `./system/Controllers/Boo/Bar.php`:
 *
 * <?php
 * namespace Controllers\Boo;
 *
 * class Bar {
 *    public function xyz() {
 *        ...
 *    }
 * }
 */

Grouping routes

The route grouping system is now much simpler, it is based on the complete URL, and you can use the * wildcard character and also the same patterns available for routes, examples:, _(*13)

<?php

/*
 * Routes will only be added if the path starts with /blog/
 * 
 * Samples:
 * 
 * http://localhost:5000/blog/
 * http://localhost:5000/blog/post
 * http://localhost:5000/blog/search
 */
$app->scope('*://*/blog/', function ($app, $params) {
    $app->action('GET', '/', function () { ... });
    $app->action('POST', '/post', function () { ... });
    $app->action('GET', '/search', function () { ... });
});

// Routes will only be added if you are accessing via HTTPS
$app->scope('https://*', function ($app, $params) {
    ...
});

// Routes will only be added if you are accessing via HTTP
$app->scope('http://*', function ($app, $params) {
    ...
});

// Routes will only be added if you are accessing mysite2.org host
$app->scope('*://mysite2.org/', function ($app, $params) {
    ...
});

// Routes will only be added if you are accessing a subdomain from main.org, like: site1.main.org
$app->scope('*://*.main.org/', function ($app, $params) {
    ...
});

// Using pattern to get the subdomain:
$app->scope('*://<subdomain>.main.org/', function ($app, $params) {
    $subdomain = $params['subdomain'];
    ...
});

// Using pattern to get path:
$app->scope('*://*/users/<id:num>/<user>', function ($app, $params) {
    $id = $params['id'];
    $username = $params['user'];
    ...
});

See more examples in the system/dev.php file, _(*14)

Route and URL patterns

It is possible to add or modify existing patterns using the $app->setPattern(name, regex) method. Creating a new pattern:, _(*15)

<?php
use Inphinit\Viewing\View;

$app->action('GET', '/about/<lang:locale>', function ($params) {
    $lang = $params['lang'];
    ...
});

$app->action('GET', '/product/<id:customid>', function ($params) {
    $lang = $params['id'];
    ...
});

$app->setPattern('locale', '[a-z]{1,8}(\-[A-Z\d]{1,8})?'); // examples: en, en-US, en-GB, pt-BR, pt
$app->setPattern('customid', '[A-Z]\d+'); // examples: A0001, B002, J007

Modifying an existing pattern:, _(*16)

<?php

// Replace semversion by <major>.<minor>.<revision>.<build>
$app->setPattern('version', '\d+\.\d+.\d+.\d+');

// Replace semversion by <major>.<minor> (maybe it's interesting for web APIs)
$app->setPattern('version', '\d+\.\d+');

Documentation

• English: https://inphinit.github.io/en/docs/
• Português: (em breve)
• API: https://inphinit.github.io/api/

The documentation is maintained in its own GitHub repository., _(*17)