I wanted to build a little app for something and I felt like playing with this framework.

* Added migrations.
* Added authentication, login bar.
* Added a Session,Log,Db Wrapper that can be gotten from the DI container.
* Setup PDO by default
* General console commands.
* Modified how templates work.

Author: tsetliff

README.md

@@ -1,6 +1,8 @@
 # Web Application Framework
 A tiny PHP web application framework.
 
+# NOTE: THIS IS A TOY PROJECT, DO NOT USE IT!
+
 I had some issues with other frameworks, so this was just intended to be a demo of implemented solutions.  A few other people and I are each writing our own minimalist web app solution just for the exercize of having done so.
 
 ## Keeping it simple
@@ -73,10 +75,6 @@ In PHPStorm I set the new server as the default and set the autoload option on t
 
 Check to make sure the files ended up on your test VM where you expected them to be.
 
-Rename the directory src/YourName/YourProject to be your name or your organizations name for your namespace root followed by the name of this project.  This may feel like a lot of directories but it keeps it PSR-0 complient for when you want to package your project or use it with another PSR-0 compliant autoloader.
-
-Then replace all the instances of YourName/YourProject in the template with the new values... what can I say the result won't have any magic since these are the example classes for you to edit, not something in the framework namespace.
-
 Edit the configuration options in public_html/config.php to match where you put everything.
 
 You should have a working hello world example.
@@ -85,7 +83,7 @@ You should have a working hello world example.
 So the idea is you set up all of the different things you need to inject in your own Di class that extends DiBase that is included with the framework. You then create one additional class to extend that class for each environment such as Dev/Prod/Testing.
 Then you set your environment in the config.php file.
 
-In your Dev environment the system creates an instance of your DiDev class, and sets it as a singleton on the DiBase object.  Throughout your project when you say Di::instance()->getWhateverComponent() you are actually calling DiDev so that it can optionally override any of your methods in your Di class but autocomplete still works fine because everything is declared in your Di class.
+In your Dev environment the system creates an instance of your DiDev class, and sets it as a singleton on the DiBase object.  Throughout your project when you say Di::getWhateverComponent() you are actually calling DiDev so that it can optionally override any of your methods in your Di class but autocomplete still works fine because everything is declared in your Di class.
 
 A common example is that you want a database PDO object that you can use in your widget repository.  So in your Di class you create the method:
 ```

template/app/config.php

@@ -0,0 +1,7 @@
+<?php
+/**
+ * This should only be the super basic configuration requirements that won't really change.
+ * Put the rest of the configuration in the Config classes so that you can manage them in git.
+ */
+define('ENVIRONMENT', 'Dev');
+define('APP_LOCATION', '/var/web-app-framework/template/app');

template/app/init.php

@@ -1,4 +1,12 @@
 <?php
+/**
+ * This is the general init file for all things within this framework.  It is for web/console/whatever so do not put
+ * things related to the context in here.
+ *
+ * Place those things in initWeb.php and initConsole.php
+ */
+
+require_once('config.php');
 require 'errorHandler.php';
 
 // Uncomment if using the composer auto loader
@@ -8,11 +16,9 @@
 require 'autoload.php';
 
 // Load the config system.
-$configName = PROJECT_NAMESPACE . '\Config\Config' . ENVIRONMENT;
+$configName = '\Config\Config' . ENVIRONMENT;
 $configName::setInstanceForEnvironment();
 
 // Setup dependency injection container based on environment
-$diName = PROJECT_NAMESPACE . '\Di\Di' . ENVIRONMENT;
-$diName::setInstanceForEnvironment();
-
-session_start();
+$diName = '\Di\Di' . ENVIRONMENT;
+$diName::setInstanceForEnvironment();

template/app/initConsole.php

@@ -0,0 +1,13 @@
+<?php
+
+require_once('init.php');
+
+/**
+ * Save adding end of line after each line.
+ *
+ * @param $msg
+ */
+function say($msg)
+{
+    echo($msg . PHP_EOL);
+}

template/app/initWeb.php

@@ -0,0 +1,5 @@
+<?php
+/**
+ * Things required for setting up the framework for web connections (as opposed to the console)
+ */
+require_once('init.php');

template/app/migrations/1533453564_example.php

@@ -0,0 +1,8 @@
+<?php
+/**
+ * Example that simply says that it ran
+ *
+ * Note that this file is ran as an include into the applyMigrations.php code so you don't need to set
+ * anything up.
+ */
+say("Example migration ran. This will cause no harm.");

template/app/migrations/1533453596_createUsersTable.sql

@@ -0,0 +1,13 @@
+DROP TABLE IF EXISTS users;
+CREATE TABLE `users` (
+  `user_id` int(10) unsigned NOT NULL AUTO_INCREMENT,
+  `first_name` varchar(200) DEFAULT '',
+  `last_name` varchar(200) DEFAULT '',
+  `email` varchar(200) DEFAULT '',
+  `password` varchar(255) DEFAULT '',
+  `entered_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  PRIMARY KEY (`user_id`),
+  KEY `first_name_idx` (`first_name`),
+  KEY `last_name_idx` (`last_name`),
+  KEY `email_idx` (`email`)
+) ENGINE=InnoDB DEFAULT CHARSET=UTF8MB4;

template/app/scripts/README

@@ -0,0 +1 @@
+General location to put things you want to run on the command line.

template/app/scripts/web-app-framework/applyMigrations.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * The purpose of this script is to run any migrations you may have
+ */
+
+use Config\Config;
+use Di\Di;
+
+require_once('../../initConsole.php');
+
+// Get a list of migrations
+$migrationFileNames = glob(APP_LOCATION . '/migrations/*');
+
+// Get a list of applied migrations
+$pdo = Di::getPdo();
+$appliedMigrations = $pdo->query("SELECT name FROM migrations")->fetchAll(PDO::FETCH_COLUMN);
+
+function applyFileThroughMysqlConsole($migrationFileName)
+{
+    say("Applying migration $migrationFileName");
+
+    $config = Config::instance();
+
+    $user = escapeshellarg($config->databaseUsername);
+    $pass = $config->databasePassword;
+    if ($pass) {
+        $pass = escapeshellarg("-p" . $pass);
+    }
+    $host = escapeshellarg($config->databaseHost);
+    $name = escapeshellarg($config->databaseName);
+    $port = escapeshellarg($config->databasePort);
+    $mysqlConsoleCommand = $config->databaseConsoleCommand;
+    $escapedMigrationFileName = escapeshellarg($migrationFileName);
+
+    $cmd = "cat $escapedMigrationFileName | $mysqlConsoleCommand -h $host -P $port -u $user $pass $name ";
+    exec($cmd, $output, $return);
+    if ($return) {
+        say("Command failed with return value $return.");
+        if ($output) {
+            print_r($output);
+        }
+        exit();
+    }
+}
+
+foreach ($migrationFileNames as $migrationFileName) {
+    $migrationName = basename($migrationFileName);
+    if (!in_array($migrationName, $appliedMigrations)) {
+        $suffix = substr($migrationFileName, -4);
+        switch ($suffix) {
+            case '.sql':
+                applyFileThroughMysqlConsole($migrationFileName);
+                break;
+            case '.php':
+                require($migrationFileName);
+                break;
+            default:
+                say("Skipping file $migrationFileName as it is not in the types I can apply.");
+        }
+        $pdo->prepare("INSERT INTO migrations SET name=?")->execute([$migrationName]);
+    } else {
+        say("Skipping $migrationName, it is already applied.");
+    }
+}

template/app/scripts/web-app-framework/setup.php

@@ -0,0 +1,73 @@
+<?php
+/**
+ * Help setting everything up
+ */
+use Di\Di;
+
+require_once('../../initConsole.php');
+
+say("Setting up the " . ENVIRONMENT . ' environment.');
+
+// Check the app location field
+if (!defined('APP_LOCATION')) {
+    say("You must edit the config.php file to set the app location!");
+    exit();
+}
+
+$whereImAt = APP_LOCATION . '/scripts/web-app-framework/setup.php';
+if ($whereImAt != __FILE__) {
+    say("The web app location does not seem to be correct. Update your config.php file.");
+    say("$whereImAt != " . __FILE__);
+    exit();
+}
+say("The App Location in the config.php file seems to be correct.");
+
+// Check the basic database connection works
+try {
+    $pdo = Di::getPdo();
+    say("Database connection ok.");
+} catch (PDOException $e) {
+    say("It looks like your database is not set up correctly.");
+    say("Verify your PDO connection information in the Config classes.");
+    say($e->getMessage());
+}
+
+// Check that the migrations table exists
+$pdo = Di::getPdo();
+$result = $pdo->query("SHOW TABLES LIKE 'migrations'")->fetchAll(PDO::FETCH_ASSOC);
+$found = count($result);
+
+if (!$found) {
+    say("Unable to find the migrations table in the database. Attempting to create it.");
+    $sql = "CREATE TABLE migrations (name VARCHAR(200) DEFAULT '' PRIMARY KEY, applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP)";
+    $pdo->query($sql);
+    say("The migrations table has been created.");
+} else {
+    say("The migrations table already exists.");
+}
+
+// Run the migrations that come with this framework
+require_once('applyMigrations.php');
+
+$sql = "SELECT COUNT(*) cnt FROM users";
+$usersFound = $pdo->query($sql)->fetchColumn();
+
+if (!$usersFound) {
+    $result = false;
+    while ($result !== true) {
+        say("No user found, creating your admin user.");
+        $firstName = readline("First Name: ");
+        $lastName = readline("Last Name: ");
+        $email = readline("Email: ");
+        $password = readline("Password: ");
+
+        $result = Di::getAuth()->addUser($email, $password, $firstName, $lastName);
+        if ($result !== true) {
+            say("That didn't work:" . Di::getAuth()->getErrorAsString($result));
+        }
+    }
+
+    say("User $firstName $lastName created with email $email");
+} else {
+    say("A user has already been found, not creating another.");
+}

template/app/src/Config/Config.php

@@ -0,0 +1,23 @@
+<?php
+namespace Config;
+
+use WebAppFramework\ConfigBase;
+
+/**
+ * Class Config
+ *
+ * @package Config
+ */
+class Config extends ConfigBase
+{
+    // Where is this website?
+    public $websiteRoot = 'http://192.168.1.19';
+
+    // Basic connection from PHP to a mysql database.
+    public $databaseHost = 'localhost';
+    public $databaseName = 'test';
+    public $databasePort = 3306;
+    public $databaseUsername = 'test';
+    public $databasePassword = 'test';
+    public $databaseConsoleCommand = 'mysql'; // Where to pipe mysql migration scripts to
+}

template/app/src/Config/ConfigDev.php

@@ -0,0 +1,15 @@
+<?php
+namespace Config;
+
+/**
+ * Class ConfigDev
+ *
+ * Use this class to override any configurations in the Config class that are
+ * specific to your development environment.
+ *
+ * @package Config
+ */
+class ConfigDev extends Config
+{
+
+}

template/app/src/Config/ConfigProd.php

@@ -0,0 +1,15 @@
+<?php
+namespace Config;
+
+/**
+ * Class ConfigProd
+ *
+ * Use this class to override any configurations in the Config class that are
+ * specific to your production environment.
+ *
+ * @package 0Config
+ */
+class ConfigProd extends Config
+{
+
+}

template/app/src/YourName/YourProject/Config/README renamed to template/app/src/Config/README

@@ -1,6 +1,4 @@
 The configuration class is chosen by the environment variable in config.php in the app directory.  Throughout
 your project however you just call Config::instance()->parameterName.  This allows for auto complete in the IDE.
 Every parameter should be defined in Config and other environment dependent changes should be made in ConfigDev,
-ConfigProd etc.
-
-Generally works like the Di.
+ConfigProd etc.

template/app/src/Controller/AuthController.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Tom
+ * Date: 2/28/2016
+ * Time: 1:14 PM
+ */
+
+namespace Controller;
+
+
+use Config\Config;
+use Di\Di;
+use WebAppFramework\ControllerBase;
+use WebAppFramework\Template;
+
+class AuthController extends ControllerBase
+{
+    public function loginAction()
+    {
+        $login = Di::getAuth()->login($this->request->get('email'), $this->request->get('password'));
+        if ($login === true) {
+            $websiteRoot = Config::instance()->websiteRoot;
+            header("Location: $websiteRoot/");
+            return;
+        }
+
+        // Failed :-(
+        $template = new Template('users/loginFailed.php');
+        $template->setVariable('error', Di::getAuth()->getErrorAsString($login));
+        $template->render();
+    }
+
+    public function logoutAction()
+    {
+        Di::getAuth()->logout();
+
+        $websiteRoot = Config::instance()->websiteRoot;
+        header("Location: $websiteRoot/");
+    }
+}

template/app/src/Controller/HomeController.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Tom
+ * Date: 2/28/2016
+ * Time: 1:14 PM
+ */
+
+namespace Controller;
+
+
+use Di\Di;
+use WebAppFramework\ControllerBase;
+use WebAppFramework\Template;
+
+class HomeController extends ControllerBase
+{
+    public function homeAction()
+    {
+        $template = new Template('home.php');
+        $template->setVariable('name', $this->request->get('name', ''));
+        $template->render();
+    }
+}