jschreuder/middle-skeleton

A Middle framework setup for a new project.

dev-master 2023-02-05 21:38 UTC

Requires

• php: >=8.1
• ext-pdo: *
• jschreuder/middle: ^2.0
• jschreuder/middle-di: dev-master
• laminas/laminas-diactoros: ^2.9
• laminas/laminas-httphandlerrunner: ^2.1
• monolog/monolog: ^2.3
• robmorgan/phinx: ^0.13
• symfony/console: ^6.0
• symfony/routing: ^6.0

Requires (Dev)

• phpspec/phpspec: ^7.2

MIT

README

A basic (though opinionated) setup for Middle framework. It is set up with the following:

• Laminas Diactoros as HTTP Message implementation, along with Laminas HTTP handlerrunner for emitting responses
• Monolog for logging
• Symfony Router
• phpspec for BDD style testing
• Phinx for database migrations
• Symfony console for commandline commands
• JSON middleware to support requests with a JSON content-type body

Installation

On the commandline use composer:

$ composer create-project jschreuder/middle-skeleton myapp dev-master

After this you will have to make the logs directory writeable:

$ chmod 0755 var/logs

Next you'll setup your configuration files. Modify the database credentials in dev.php to your liking. You can change environment by renaming the dev.php file and editing the return value of env.php to return that name.

$ mv etc/dev.php.dist etc/dev.php
$ mv etc/env.php.dist etc/env.php

After this you should also set the correct credentials in the environment config file if you intend to use a database.

Finally: you might want to put everything under a different namespace ;-)

Test if it works

Go to the commandline and enter ./console middle:example MyName to show a welcome message. The command is located in src/Command/ExampleCommand.php.

Go to the commandline and into the web directory, enter php -S localhost:8080 and go to http://localhost:8080 in your browser. It should show a JSON encoded Hello World message. The controller for this is located in src/Controller/ExampleController.php, the routing is set up in src/GeneralRoutingProvider.php.

Run bin/phpspec run to have phpspec run the specs on the example classes.

The wiring

There's a few files in which the application is wired together:

• The etc/app_init.php which loads the autoloader, sets some reasonable environment settings, sets up Monolog, and initiates the DiC with the GeneralServiceProvider;
• The web/index.php which is the entry point for the web application and will load the routes & run the request through the application;
• The console which registers the commands;
• The DiC is configured in the ServiceContainer class;
• Routing is configured in the GeneralRoutingProvider class;
• Console commands are configured in the ConsoleCommandsProvider class.

Included in Middle framework

There's a few things included in Middle framework you might want to consider but have not been set up yet:

• Sessions: You can use the SessionMiddleware along with the Laminas implementation to add session support to the application. Note that you will need to install the Laminas Session package as well.
• Views / templates: You can use the View and Renderer classes with Twig to generate output from powerful templates. Or implement your own view layer based on the available interfaces.
• Use request validators & request filters to check HTTP requests before they reach their controller.