Initial commit

.coveralls.yml

@@ -0,0 +1 @@
+json_path: coveralls-upload.json

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: composer
+  directory: "/"
+  schedule:
+    interval: monthly
+  # open-pull-requests-limit: 10
+  versioning-strategy: increase
+  ignore:
+    - dependency-name: "doctrine/orm"
+      versions: ["3.x"]
+    - dependency-name: "php-di/php-di-name"
+      update-types: ["version-update:semver-major"]

.github/workflows/tests.yml

@@ -0,0 +1,61 @@
+name: Tests
+
+on: 
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+    tests:
+        name: Tests PHP ${{ matrix.php }}
+        runs-on: ubuntu-latest
+        continue-on-error: ${{ matrix.experimental }}
+        strategy:
+            fail-fast: false
+            matrix:
+                php: [7.4, 8.0, 8.1, 8.2, 8.3]
+                experimental: [false]
+                include:
+                    - php: 8.3
+                      analysis: true
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+
+            - name: Set up PHP ${{ matrix.php }}
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.php }}
+                  coverage: xdebug
+
+            - name: Validate composer.json
+              run: composer validate --strict --no-check-lock
+
+            - name: Install dependencies with Composer
+              uses: ramsey/composer-install@v2
+
+            - name: Coding standards
+              if: matrix.analysis
+              run: vendor/bin/phpcs
+
+            - name: Static analysis
+              if: matrix.analysis
+              run: vendor/bin/phpstan
+
+            - name: Doctrine database
+              run:  |
+                ./vendor/bin/doctrine orm:schema-tool:update --dump-sql
+                ./vendor/bin/doctrine orm:schema-tool:update --force
+
+            - name: Tests
+              run: vendor/bin/phpunit --coverage-clover clover.xml
+
+            # - name: Upload coverage results to Coveralls
+            #   if: matrix.analysis
+            #   env:
+            #       COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            #   run: |
+            #       composer require php-coveralls/php-coveralls -n -W
+            #       vendor/bin/php-coveralls --coverage_clover=clover.xml -v

.gitignore

@@ -0,0 +1,28 @@
+.idea/
+
+# IDE
+.vscode/
+nbproject/
+.DS_STORE
+/coverage/
+
+# Vendor
+/vendor/
+
+# Logs
+/logs/*
+!/logs/README.md
+
+# Cache
+/var/cache/*
+.phpunit.result.cache
+cache.properties
+.php_cs.cache
+
+# Composer
+composer.phar
+composer.lock
+
+# Doctrine
+var/doctrine/*
+var/data.db

.htaccess

@@ -0,0 +1,19 @@
+Options All -Indexes
+
+# Protect .htaccess and .htpasswd files.
+<Files ".ht*">
+    Require all denied
+</Files>
+
+<IfModule mod_rewrite.c>
+  # Redirect to the public folder
+  RewriteEngine On
+  # RewriteBase /
+  RewriteRule ^$ public/ [L]
+  RewriteRule (.*) public/$1 [L]
+
+  # Redirect to HTTPS
+  # RewriteEngine On
+  # RewriteCond %{HTTPS} off
+  # RewriteRule ^(.*)$ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
+</IfModule>

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# How to Contribute
+
+## Pull Requests
+
+1. Fork the Slim Skeleton repository
+2. Create a new branch for each feature or improvement
+3. Send a pull request from each feature branch to the **4.x** branch
+
+It is very important to separate new features or improvements into separate feature branches, and to send a
+pull request for each branch. This allows us to review and pull in new features or improvements individually.
+
+## Style Guide
+
+All pull requests must adhere to the [PSR-12 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md).

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Antonino M.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,42 @@
+# Slim Framework 4 Skeleton Application with Doctrine ORM 2
+
+[![Build Status](https://github.com/AntoninoM90/slim4-doctrine-skeleton/workflows/Tests/badge.svg)](https://github.com/AntoninoM90/slim4-doctrine-skeleton/actions)
+
+Use this skeleton application to quickly setup and start working on a new Slim Framework 4 application. This application uses the latest Slim 4 with Slim PSR-7 implementation and PHP-DI container implementation. It also uses the Monolog logger.
+
+This skeleton application was built for Composer. This makes setting up a new Slim Framework application quick and easy.
+
+## Install the Application
+
+Run this command from the directory in which you want to clone the Slim Framework application skeleton. You will require PHP 7.4 or newer.
+
+```bash
+git clone https://github.com/AntoninoM90/slim4-doctrine-skeleton.git
+```
+
+You'll want to:
+
+* Point your virtual host document root to your new application's `public/` directory.
+* Ensure `logs/` is web writable.
+
+To run the application in development, you can run these commands
+
+```bash
+cd [my-app-name]
+composer start
+```
+
+Or you can use `docker-compose` to run the app with `docker`, so you can run these commands:
+```bash
+cd [my-app-name]
+docker-compose up -d
+```
+After that, open `http://localhost:8080` in your browser.
+
+Run this command in the application directory to run the test suite
+
+```bash
+composer test
+```
+
+That's it! Now go build something cool.

app/bootstrap.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+use App\Application\Handlers\HttpErrorHandler;
+use App\Application\Handlers\ShutdownHandler;
+use App\Application\ResponseEmitter\ResponseEmitter;
+use App\Application\Settings\SettingsInterface;
+use DI\ContainerBuilder;
+use Psr\Log\LoggerInterface;
+use Slim\Factory\AppFactory;
+use Slim\Factory\ServerRequestCreatorFactory;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+// Instantiate PHP-DI ContainerBuilder
+$containerBuilder = new ContainerBuilder();
+
+if (false) { // Should be set to true in production
+  $containerBuilder->enableCompilation(__DIR__ . '/../var/cache');
+}
+
+// Set up settings
+$settings = require __DIR__ . '/settings.php';
+$settings($containerBuilder);
+
+// Set up dependencies
+$dependencies = require __DIR__ . '/dependencies.php';
+$dependencies($containerBuilder);
+
+// Build PHP-DI Container instance
+$container = $containerBuilder->build();
+
+// Instantiate the app
+AppFactory::setContainer($container);
+$app = AppFactory::create();
+$callableResolver = $app->getCallableResolver();
+
+// Register middlewares
+$middleware = require __DIR__ . '/middleware.php';
+$middleware($app);
+
+// Register routes
+$routes = require __DIR__ . '/routes.php';
+$routes($app);
+
+// Get settings from container
+/** @var SettingsInterface $settings */
+$settings = $container->get(SettingsInterface::class);
+
+// Get the logger from the container
+/** @var LoggerInterface $logger */
+$logger = $container->get(LoggerInterface::class);
+
+// Get the display and error logging settings
+/** @var bool $displayErrorDetails */
+$displayErrorDetails = $settings->get('displayErrorDetails');
+
+/** @var bool $logError */
+$logError = $settings->get('logError');
+
+/** @var bool $logErrorDetails */
+$logErrorDetails = $settings->get('logErrorDetails');
+
+// Create Request object from globals
+$serverRequestCreator = ServerRequestCreatorFactory::create();
+$request = $serverRequestCreator->createServerRequestFromGlobals();
+
+// Ger the response factory and create the error handler
+$responseFactory = $app->getResponseFactory();
+$errorHandler = new HttpErrorHandler(
+    $callableResolver,
+    $responseFactory,
+    $logger
+);
+
+// Create and register the shutdown handler
+$shutdownHandler = new ShutdownHandler(
+    $request,
+    $errorHandler,
+    $displayErrorDetails,
+    $logError,
+    $logErrorDetails
+);
+register_shutdown_function($shutdownHandler);
+
+// Add the Slim routing middleware
+$app->addRoutingMiddleware();
+
+// Add the Slim body parsing middleware
+$app->addBodyParsingMiddleware();
+
+// Add Error Middleware
+$errorMiddleware = $app->addErrorMiddleware(
+    $displayErrorDetails,
+    $logError,
+    $logErrorDetails,
+    $logger
+);
+$errorMiddleware->setDefaultErrorHandler($errorHandler);
+
+// Run the application and emit the application response
+$response = $app->handle($request);
+$responseEmitter = new ResponseEmitter();
+$responseEmitter->emit($response);