zapheus/zapheus

An independent and framework-friendly PHP micro-framework.

Zapheus

![Latest Version on Packagist][ico-version] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Inspired from PHP frameworks of all shape and sizes, Zapheus is a web application framework with a goal to be easy to use, educational, and fully extensible to the core. Whether a simple API project or a full enterprise application, Zapheus will try to adapt it according to developer's needs., _(*2)

``` php // Displays a "Hello World" text., <sub>(*3)</sub>

require 'vendor/autoload.php';, <sub>(*4)</sub>

// Initializes the router application $app = new Zapheus\Coordinator;, <sub>(*5)</sub>

// Creates a HTTP route of GET / $app->get('/', function () { return 'Hello world!'; });, <sub>(*6)</sub>

// Handles the server request echo $app->run();, <sub>(*7)</sub>

## Installation

Install `Zapheus` via [Composer](https://getcomposer.org/):

``` bash
$ composer require zapheus/zapheus

Basic Usage

Using Coordinator

``` php require 'vendor/autoload.php';, <sub>(*8)</sub>

// Initializes the router application $app = new Zapheus\Coordinator;, <sub>(*9)</sub>

// Creates a HTTP route of GET / $app->get('/', function () { return 'Hello world!'; });, <sub>(*10)</sub>

// Handles the server request echo $app->run();, <sub>(*11)</sub>

### Using `Middlelayer`

``` php
require 'vendor/autoload.php';

// Initializes the middleware application
$app = new Zapheus\Middlelayer;

// Initializes the router instance
$router = new Zapheus\Routing\Router;

// Creates a HTTP route of GET /
$router->get('/', function ()
{
    return 'Hello world!';
});

// Pipes the router middleware into the application
$app->pipe(function ($request, $next) use ($router)
{
    // Returns the request attribute value for a route
    $attribute = Zapheus\Application::ROUTE_ATTRIBUTE;

    // Returns the path from the URI instance
    $path = $request->uri()->path();

    // Returns the current HTTP method from the $_SERVER
    $method = $request->method();

    // Creates a new Routing\DispatcherInterface instance
    $dispatcher = new Zapheus\Routing\Dispatcher($router);

    // Dispatches the router against the current request
    $route = $dispatcher->dispatch($method, $path);

    // Sets the route attribute into the request in order to be
    // called inside the Application instance and return the response.
    $request = $request->push('attributes', $route, $attribute);

    // Go to the next middleware, if there are any
    return $next->handle($request);
});

// Handles the server request
echo $app->run();

Run the application using PHP's built-in web server:

``` bash $ php -S localhost:8000, <sub>(*12)</sub>

Open your web browser and go to [http://localhost:8000](http://localhost:8000).

## Features

### No dependencies

Zapheus takes no dependencies from other frameworks or libraries. Each component is built with inspiration from the existing popular web frameworks to give developers the best development experience.

### Extensible

All of Zapheus' classes have their own easy to understand interfaces. It enables developers to extend or optimize the core functionalities easily.

### Interoperable

Even though Zapheus doesn't have dependencies from other libraries, it does have [bridge packages](https://github.com/zapheus?utf8=%E2%9C%93&q=bridge) to integrate your chosen libraries easily within the framework. These include the [PHP Standards Recommendations](https://www.php-fig.org/psr/) (PSR) like [PSR-07](https://github.com/zapheus/psr-07-bridge) and [PSR-11](https://github.com/zapheus/psr-11-bridge).

``` php
// Converts a Zend Diactoros instance (a PSR-07 implementation)
// into a Zapheus HTTP request using the PSR-07 Bridge package

use Zapheus\Bridge\Psr\Zapheus\Request;
use Zend\Diactoros\ServerRequestFactory;

// Psr\Http\Message\ServerRequestInterface
$psr = ServerRequestFactory::fromGlobals();

// Zapheus\Http\Message\RequestInterface
$request = new Request($psr);

Framework-friendly

Frameworks like Laravel and Symfony have their way of integrating packages into their own ecosystem. With that, Zapheus will try to get them both work in the same application in order for the developers to utilize framework-specific packages to their arsenal., <sub>(*13)</sub>

``` php // Registers a third-party Laravel Service Provider // into Zapheus using the Illuminate Bridge package, <sub>(*14)</sub>

use Acme\Providers\AuthServiceProvider; use Acme\Providers\RoleServiceProvider; use Illuminate\Container\Container; use Zapheus\Bridge\Illuminate\IlluminateProvider; use Zapheus\Container\Container as ZapheusContainer;, <sub>(*15)</sub>

// A collection of Laravel Service Providers $providers = array(AuthServiceProvider::class, RoleServiceProvider::class);, <sub>(*16)</sub>

// Include the providers in the bridge instance $provider = new IlluminateProvider($providers);, <sub>(*17)</sub>

// Registers the bindings into a container $container = $provider->register(new ZapheusContainer);, <sub>(*18)</sub>

// Returns the Illuminate\Container\Container $laravel = $container->get(Container::class);, <sub>(*19)</sub>

## Changelog

Please see [CHANGELOG][link-changelog] for more information what has changed recently.

## Testing

``` bash
$ composer test

Credits

• All contributors

License

The MIT License (MIT). Please see LICENSE for more information., <sub>(*20)</sub>