README

Slytherin is a simple and extensible PHP micro-framework that tries to achieve a SOLID-based design for creating web applications. It uses Composer as the dependency package manager to add, update or even remove external packages.

Background

In the current state of PHP ecosystem, the mostly used PHP frameworks like Symfony and Laravel provide a great set of tools for every PHP software engineer. While the said PHP frameworks provide a kitchen-sink solution for every need (e.g., content management system (CMS), CRUD, etc.), they are sometimes overkill, overwhelming at first, or sometimes uses a strict directory structure.

With this, Slytherin tries an alternative approach to only require the basic tools like HTTP and Routing and let the application evolve from a simple API tool to a full-featured web application. With no defined directory structure, Slytherin can be used to mix and match any structure based on the application's requirements and to encourage the use of open-source packages in the PHP ecosystem.

Basic Example

Below is an example code for creating a simple application using Slytherin:

// app/web/index.php

use Rougin\Slytherin\Application;

// Load the Composer autoloader ----
$root = dirname(dirname(__DIR__));

require "$root/vendor/autoload.php";
// ---------------------------------

// Create a new application instance ---
$app = new Application;
// -------------------------------------

// Create a new HTTP route ---
$app->get('/', function ()
{
    return 'Hello world!';
});
// ---------------------------

// Then run the application after ---
echo $app->run();
// ----------------------------------

Kindly check the The First "Hello World" page in the wiki for more information in the provided sample code above.

Upgrade Guide

As Slytherin is evolving as a micro-framework, there might be some breaking changes in its internal code during development. The said changes can be found in the Upgrade Guide page.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

To check all written test cases, kindly install the specified third-party packages first:

$ composer request filp/whoops --dev
$ composer request league/container --dev
$ composer request nikic/fast-route --dev
$ composer request phroute/phroute --dev
$ composer request rdlowrey/auryn --dev
$ composer request twig/twig --dev
$ composer request zendframework/zend-diactoros --dev
$ composer request zendframework/zend-stratigility --dev
$ composer test

Credits

Slytherin is inspired by the following packages below and their respective implementations. Their contributions improved my understanding of writing frameworks and creating application logic from scratch:

Awesome PHP! by Jamie York;
Codeigniter by EllisLab/British Columbia Institute of Technology;
Fucking Small by Tony Quilkey;
Laravel by Taylor Otwell;
No Framework Tutorial by Patrick Louys;
PHP Design Patterns by Dominik Liebler;
PHP Standard Recommendations by PHP-FIG;
Symfony by SensioLabs; and
All of the contributors in this package.

License

The MIT License (MIT). Please see LICENSE for more information.

rougin / slytherin

Maintainers

Details