Move out of the Backend folder; Top-Level composer

felix-schindler · Oct 27, 2022 · c85a2a3 · c85a2a3
1 parent e4f8395
commit c85a2a3
Show file tree

Hide file tree

Showing 28 changed files with 44 additions and 28 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,2 @@
-/Backend/Libraries/vendor/
+vendor/
 .DS_Store
diff --git a/.phpstan.neon b/.phpstan.neon
@@ -1,7 +1,9 @@
 parameters:
 	level: 6
 	excludePaths:
-		- Backend/Libraries/vendor/*
+		- vendor/*
 	paths:
 		- index.php
-		- Backend
+		- Controllers
+		- Core
+		- Views
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -4,7 +4,7 @@
         {
             "label": "PHPStan",
             "type": "shell",
-            "command": "php Backend/Libraries/vendor/bin/phpstan analyse -c .phpstan.neon --memory-limit 500M",
+            "command": "php vendor/bin/phpstan analyse -c .phpstan.neon --memory-limit 500M",
             "group": {
                 "kind": "build",
                 "isDefault": true

diff --git a/Backend/Libraries/composer.json b/Backend/Libraries/composer.json
diff --git a/Backend/Controllers/APIController.php → Controllers/APIController.php b/Backend/Controllers/APIController.php → Controllers/APIController.php
diff --git a/Backend/Controllers/HomeController.php → Controllers/HomeController.php b/Backend/Controllers/HomeController.php → Controllers/HomeController.php
diff --git a/Backend/Controllers/NotCalledController.php → Controllers/NotCalledController.php b/Backend/Controllers/NotCalledController.php → Controllers/NotCalledController.php
diff --git a/Backend/Controllers/SecondHome.php → Controllers/SecondHome.php b/Backend/Controllers/SecondHome.php → Controllers/SecondHome.php
diff --git a/Backend/Core/ClassLoader.php → Core/ClassLoader.php b/Backend/Core/ClassLoader.php → Core/ClassLoader.php
diff --git a/Backend/Core/Data/Database.php → Core/Data/Database.php b/Backend/Core/Data/Database.php → Core/Data/Database.php
@@ -40,6 +40,9 @@ public function execute(string $queryStr, array $values): bool
 	 * Reads data (row by row) from database
 	 * Access returned value via $return['ColumnName']
 	 *
+	 * This should be executed if only one
+	 * row is returned or in a do-while loop
+	 *
 	 * @see https://bugs.php.net/bug.php?edit=2&id=44341 Always string values!
 	 * @throws PDOException When anything goes wrong
 	 * @return array<string,string>|null Result as array - null on failure

diff --git a/Backend/Core/Data/InsertQuery.php → Core/Data/InsertQuery.php b/Backend/Core/Data/InsertQuery.php → Core/Data/InsertQuery.php
diff --git a/Backend/Core/Data/Model.php → Core/Data/Model.php b/Backend/Core/Data/Model.php → Core/Data/Model.php
diff --git a/Backend/Core/Data/Query.php → Core/Data/Query.php b/Backend/Core/Data/Query.php → Core/Data/Query.php
diff --git a/Backend/Core/Functions/Auth.php → Core/Functions/Auth.php b/Backend/Core/Functions/Auth.php → Core/Functions/Auth.php
diff --git a/Backend/Core/Functions/Utils.php → Core/Functions/Utils.php b/Backend/Core/Functions/Utils.php → Core/Functions/Utils.php
diff --git a/Backend/Core/System/Controller.php → Core/System/Controller.php b/Backend/Core/System/Controller.php → Core/System/Controller.php
diff --git a/Backend/Core/System/IO.php → Core/System/IO.php b/Backend/Core/System/IO.php → Core/System/IO.php
diff --git a/Backend/Core/System/Router.php → Core/System/Router.php b/Backend/Core/System/Router.php → Core/System/Router.php
diff --git a/Backend/Core/System/View.php → Core/System/View.php b/Backend/Core/System/View.php → Core/System/View.php
diff --git a/README.md b/README.md
@@ -1,31 +1,39 @@
 # Router
 
-Since I'm mostly using [SvelteKit](https://github.com/sveltejs/kit) and [PocketBase](https://github.com/pocketbase/pocketbase), this Router is no longer maintained. Maybe when I'm getting bored, I'll fix / improve one or two things.
+Since I'm mostly using [SvelteKit](https://github.com/sveltejs/kit) and
+[PocketBase](https://github.com/pocketbase/pocketbase), this Router is no longer
+actively maintained. When I'm bored, I might fix / improve a few things.
 
 ## Why use this?
 
 - Dependency-free
 - MVC
-- No Models included, but you use PDO with the [Query class](/Backend/Core/Data/Query.php)
-- Easy to use readable URLs like "/u/:name" instead of things like "user.php?name="
+- No Models included, but you use PDO with the
+  [Query class](/Core/Data/Query.php) and
+  [Database class](/Core/Data/Database.php)
+- Easy to use readable URLs like "/u/:name" instead of things like
+  "user.php?name="
 
 ## Getting started
 
-1. Clone GitHub Repo - `git clone git@github.com:felix-schindler/Router.git && cd Router`
-2. Run `php -S localhost:8080` or throw it on a web server
+1. Clone GitHub Repo -
+   `git clone git@github.com:felix-schindler/Router.git && cd Router`
+2. (Run `composer install` if you want to use `phpstan`)
+3. Run `php -S localhost:8080` or throw it on a web server
 
 ## Requirements
 
-- [PHP 8.1](https://www.php.net) with [PDO](https://www.php.net/manual/de/book.pdo.php)
-- __OPTIONAL__: [Composer](https://getcomposer.org)
+- [PHP 8.1](https://www.php.net) with
+  [PDO](https://www.php.net/manual/de/book.pdo.php)
+- **OPTIONAL**: [Composer](https://getcomposer.org)
 
 ## Remove junk
 
-This router is dependency-free. The only composer package installed is [PHPStan](https://phpstan.org), for static code analysis. Remove composer with
+This router is dependency-free. The only composer package installed is
+[PHPStan](https://phpstan.org), for static code analysis. Remove composer with
 
 ```zsh
-rm -rf Backend/Libraries
-rm .phpstan.neon
+rm -rf composer* vendor/ .phpstan.neon
 ```
 
 and remove the autoloader from the `index.php` file.

diff --git a/Backend/Views/Base/APIView.php → Views/Base/APIView.php b/Backend/Views/Base/APIView.php → Views/Base/APIView.php
diff --git a/Backend/Views/Base/ErrorView.php → Views/Base/ErrorView.php b/Backend/Views/Base/ErrorView.php → Views/Base/ErrorView.php
diff --git a/Backend/Views/Base/LayoutView.php → Views/Base/LayoutView.php b/Backend/Views/Base/LayoutView.php → Views/Base/LayoutView.php
diff --git a/Backend/Views/Components/HeadingView.php → Views/Components/HeadingView.php b/Backend/Views/Components/HeadingView.php → Views/Components/HeadingView.php
diff --git a/Backend/Views/Components/TextView.php → Views/Components/TextView.php b/Backend/Views/Components/TextView.php → Views/Components/TextView.php
diff --git a/composer.json b/composer.json
@@ -0,0 +1,6 @@
+{
+	"require": {
+		"php": "^8.1",
+		"phpstan/phpstan": "^1.2"
+	}
+}
diff --git a/Backend/Libraries/composer.lock → composer.lock b/Backend/Libraries/composer.lock → composer.lock
diff --git a/index.php b/index.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 $GLOBALS['start'] = microtime(true);		// Meassure execution time -> look in Layout <footer>
 
@@ -18,14 +18,14 @@
 define("DB_USER", "user");
 define("DB_PASS", "pass");
 
-define("TITLE", "Sample");									// Title for website
-define("DOMAIN", "https://schindlerfelix.de");				// Hosted on this domain
+define("TITLE", "Sample");											// Title for website
+define("DOMAIN", "https://schindlerfelix.de");	// Hosted on this domain
 
 // Require autoloaders
-require_once("./Backend/Core/ClassLoader.php");				// Load classes
-// require_once("./Backend/Libraries/vendor/autoload.php");	// Composer autoloader
+require_once("./Core/ClassLoader.php");					// Load classes
+// require_once("./vendor/autoload.php");				// Composer autoloader
 
 // Application start
-// session_start();		// Start PHP Session
+// session_start();			// Start PHP Session (should only be executed if you use session variables)
 ClassLoader::파람();	// Run the class loader
-Router::艳颖();			// Run router
+Router::艳颖();				// Run router