Initial PHP project structure

2022-11-01 18:09:46 -04:00 · 2022-11-01 18:09:46 -04:00 · 7c793dac88
commit 7c793dac88
parent 836d3ecc65
11 changed files with 1555 additions and 0 deletions
--- a/bin/run-php.sh
+++ b/bin/run-php.sh
@ -0,0 +1,4 @@
+#!/bin/sh
+
+# start a local instance of the app using PHP's built-in webserver
+php -S localhost:8080 -t public/ public/index.php
--- a/composer.json
+++ b/composer.json
@ -0,0 +1,24 @@
+{
+    "name": "bitgoblin/overseer",
+    "description": "Self-hosted inventory tracking web app",
+    "type": "project",
+    "license": "BSD-2-Clause",
+    "autoload": {
+        "psr-4": {
+            "BitGoblin\\Overseer\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Gregory Ballantine",
+            "email": "gballantine@bitgoblin.tech"
+        }
+    ],
+    "minimum-stability": "stable",
+    "require": {
+        "slim/slim": "^4.10",
+        "slim/psr7": "^1.5",
+        "php-di/php-di": "^6.4",
+        "slim/twig-view": "^3.3"
+    }
+}
--- a/composer.lock
+++ b/composer.lock
--- a/public/.htaccess
+++ b/public/.htaccess
@ -0,0 +1,5 @@
+# rewrite rules
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule ^ index.php [QSA,L]
--- a/public/index.php
+++ b/public/index.php
@ -0,0 +1,24 @@
+<?php
+
+// if we're looking for static files in dev, return false so they can be served.
+if (PHP_SAPI == 'cli-server') {
+  $url  = parse_url($_SERVER['REQUEST_URI']);
+  $file = __DIR__ . $url['path'];
+
+  // check the file types, only serve standard files
+  if (preg_match('/\.(?:png|js|jpg|jpeg|gif|css)$/', $file)) {
+    // does the file exist? If so, return it
+    if (is_file($file))
+        return false;
+
+    // file does not exist. return a 404
+    header($_SERVER['SERVER_PROTOCOL'].' 404 Not Found');
+    printf('"%s" does not exist', $_SERVER['REQUEST_URI']);
+    return false;
+  }
+}
+
+require_once __DIR__ .  '/../src/app.php';
+
+$app->run();
+
--- a/src/Controllers/Controller.php
+++ b/src/Controllers/Controller.php
@ -0,0 +1,19 @@
+<?php
+
+namespace BitGoblin\Overseer\Controllers;
+
+use Psr\Container\ContainerInterface;
+
+class Controller {
+
+  protected $container;
+
+  public function __construct(ContainerInterface $container) {
+    $this->container = $container;
+  }
+
+  public function get(string $name) {
+    return $this->container->get($name);
+  }
+
+}
--- a/src/Controllers/HomeController.php
+++ b/src/Controllers/HomeController.php
@ -0,0 +1,16 @@
+<?php
+
+namespace BitGoblin\Overseer\Controllers;
+
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+use Slim\Views\Twig;
+
+class HomeController extends Controller {
+
+  public function getIndex(Request $request, Response $response): Response {
+    $view = Twig::fromRequest($request);
+    return $view->render($response, 'index.twig');
+  }
+
+}
--- a/src/app.php
+++ b/src/app.php
@ -0,0 +1,25 @@
+<?php
+
+use DI\Container;
+use Slim\Factory\AppFactory;
+use Slim\Views\Twig;
+use Slim\Views\TwigMiddleware;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+// Create new container object and add our config object to it
+$container = new Container();
+
+// Set container to create App with on AppFactory
+AppFactory::setContainer($container);
+$app = AppFactory::create();
+
+// create Twig instance
+$twig = Twig::create('views', ['cache' => false]);
+// add Twig-View Middleware
+$app->add(TwigMiddleware::create($app, $twig));
+
+// load routes
+require_once __DIR__ . '/routes.php';
+
+// app starts in public/index.php
--- a/src/routes.php
+++ b/src/routes.php
@ -0,0 +1,7 @@
+<?php
+
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
+
+// index GET route - this page should welcome the user and direct them to the available actions
+$app->get('/', '\\BitGoblin\\Overseer\\Controllers\\HomeController:getIndex')->setName('index');
--- a/views/index.twig
+++ b/views/index.twig
@ -0,0 +1,12 @@
+{% extends 'layout.twig' %}
+
+{% block content %}
+
+<!-- page header -->
+<header class="row">
+  <div class="columns twelve">
+    <h1>Welcome to Overseer!</h1>
+  </div>
+</header>
+
+{% endblock %}
--- a/views/layout.twig
+++ b/views/layout.twig
@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>{% block title %}{% endblock %} | Overseer</title>
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css">
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/skeleton/2.0.4/skeleton.min.css">
+  <link rel="stylesheet" href="/css/wyrm.css">
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
+  <script src="/js/drake.js"></script>
+</head>
+<body>
+  <!-- global navigation -->
+  <nav class="navbar">
+    <div class="navbar-left">
+      <ul>
+        <li class="menu-text">Overseer</li>
+        <li><a href="/">Home</a></li>
+        <li><a href="/search">Search</a></li>
+        <li><a href="/add">Add Item</a></li>
+      </ul>
+    </div>
+  </nav>
+
+  <!-- main content -->
+  <div id="main-content" class="container">
+    {% block content %}{% endblock %}
+  </div>
+</body>
+</html>