Update

Author: ibehnoosh

Diff for: .gitignore

@@ -0,0 +1,3 @@
+.idea
+.env
+vendor

Diff for: .phpunit.result.cache

@@ -0,0 +1,34 @@
+#### The exercise for the PHP course "Learn PHP The Right Way" lesson 2.33.
+
+---
+#### Course Playlist
+https://www.youtube.com/watch?v=sVbEyFZKgqk&list=PLr3d3QYzkw2xabQRUpcZ_IBk9W50M9pe-
+
+---
+#### Summary
+At the end of the section 1 of the course we did a mini project & exercise where we built a transaction file importer. We did it procedural way & also read the files from directory instead of letting user upload them. This exercise is for you to implement the same thing but use OOP as well as database to store the imported transactions & then display them on the screen like this:
+![Sample Output](result.png)
+
+I have provided you with the skeleton of code that you can work with, it is what we already covered in the second section of the course (in the last few lessons). You can refer to [this video](https://youtu.be/iCKzIIE4w5E) to understand the structure of the code. Note that you can write the whole thing on your own & don't use this structure at all, the goal is to simply accept a file upload of transactions, save them in transactions table & color code expense/income when displaying the transactions table. You can look at the code that I wrote & explained in [this video](https://youtu.be/MOsolLaVnsI) & convert it into OOP if you wish.
+
+---
+#### Instructions
+1. Clone this repository to your local or download it.
+2. If you are using docker you can `cd` into the docker directory & run `docker-compose up -d`. If you are using something else like XAMPP just make sure you have Web Server (Apache), PHP & MySQL running.
+   * Please note that **PHP 8** is required if you want to use the skeleton that I am providing. You will need to adjust the code to make it work for lower PHP versions.
+3. Create a `.env` file by copying variables from `.env.example`. Fill in those values in `.env` file.
+4. Make sure that whatever database name you enter actually exists, if not, create that database.
+5. Confirm that once you open your `http://localhost:8000` it loads the home page.
+6. Create a new route & controller that will let you upload the transactions CSV file. The UI is not important, so you don't even need any CSS. If you want you can use `HomeController` and simply add a new method and route for it or create a new controller entirely.
+7. Your controller should accept the uploaded file, read it line by line & save the data into the **transactions** table. You can download the sample transactions file to upload [here](./transactions_sample.csv)
+   * Create the **transactions** table with appropriate columns to store the data
+   * Create a model within the **Models** directory to actually process the file & save data into the database
+   * First column is the date of the transaction
+   * Second column is the check # which is optional & is not always provided
+   * The third column is transaction description
+   * The fourth column is the amount (negative number indicates it's an expense, positive number indicates it's an income), it's up to you how you want to store it
+8. The view file is provided for you under `views/transactions.php` you just need to render this from your controller & pass down the necessary data to display transactions.
+   * The date of the transaction should be in this format "Jan 4, 2021"
+   * Show income amounts in green color & show expense amounts in red
+9. Submit the PR with your changes, I will review & provide feedback, if you get stuck or have any questions let me know.
+10. **Bonus:** Allow multiple file uploads so that more than one CSV file can be uploaded at the same time.

Diff for: README.md

@@ -0,0 +1,9 @@
+<?php
+
+
+use PHPUnit\Framework\TestCase;
+
+class Test extends TestCase
+{
+
+}

Diff for: Test.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace App;
+
+use App\Exceptions\RouteNotFoundException;
+
+class App
+{
+    private static DB $db;
+
+    public function __construct(protected Router $router, protected array $request, protected Config $config)
+    {
+        static::$db = new DB($config->db ?? []);
+    }
+
+    public static function db(): DB
+    {
+        return static::$db;
+    }
+
+    public function run()
+    {
+        try {
+            echo $this->router->resolve($this->request['uri'], strtolower($this->request['method']));
+        } catch (RouteNotFoundException) {
+            http_response_code(404);
+
+            echo View::make('error/404');
+        }
+    }
+}

Diff for: app/App.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace App;
+
+/**
+ * @property-read ?array $db
+ */
+class Config
+{
+    protected array $config = [];
+
+    public function __construct(array $env)
+    {
+        $this->config = [
+            'db' => [
+                'host'     => $env['DB_HOST'],
+                'user'     => $env['DB_USER'],
+                'pass'     => $env['DB_PASS'],
+                'database' => $env['DB_DATABASE'],
+                'driver'   => $env['DB_DRIVER'] ?? 'mysql',
+            ],
+        ];
+    }
+
+    public function __get(string $name)
+    {
+        return $this->config[$name] ?? null;
+    }
+}

Diff for: app/Config.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace App\Controllers;
+
+use App\View;
+
+class HomeController
+{
+    public function index(): View
+    {
+        return View::make('index');
+    }
+}

Diff for: app/Controllers/HomeController.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace App;
+
+use PDO;
+
+/**
+ * @mixin PDO
+ */
+class DB
+{
+    private PDO $pdo;
+
+    public function __construct(array $config)
+    {
+        $defaultOptions = [
+            PDO::ATTR_EMULATE_PREPARES   => false,
+            PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
+        ];
+
+        try {
+            $this->pdo = new PDO(
+                $config['driver'] . ':host=' . $config['host'] . ';dbname=' . $config['database'],
+                $config['user'],
+                $config['pass'],
+                $config['options'] ?? $defaultOptions
+            );
+        } catch (\PDOException $e) {
+            throw new \PDOException($e->getMessage(), (int) $e->getCode());
+        }
+    }
+
+    public function __call(string $name, array $arguments)
+    {
+        return call_user_func_array([$this->pdo, $name], $arguments);
+    }
+}

Diff for: app/DB.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace App\Exceptions;
+
+class RouteNotFoundException extends \Exception
+{
+    protected $message = '404 Not Found';
+}

Diff for: app/Exceptions/RouteNotFoundException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace App\Exceptions;
+
+class ViewNotFoundException extends \Exception
+{
+    protected $message = 'View not found';
+}

Diff for: app/Exceptions/ViewNotFoundException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace App;
+
+abstract class Model
+{
+    protected DB $db;
+
+    public function __construct()
+    {
+        $this->db = App::db();
+    }
+}

Diff for: app/Model.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+use App\Exceptions\RouteNotFoundException;
+
+class Router
+{
+    private array $routes;
+
+    public function register(string $requestMethod, string $route, callable|array $action): self
+    {
+        $this->routes[$requestMethod][$route] = $action;
+
+        return $this;
+    }
+
+    public function get(string $route, callable|array $action): self
+    {
+        return $this->register('get', $route, $action);
+    }
+
+    public function post(string $route, callable|array $action): self
+    {
+        return $this->register('post', $route, $action);
+    }
+
+    public function routes(): array
+    {
+        return $this->routes;
+    }
+
+    public function resolve(string $requestUri, string $requestMethod)
+    {
+        $route = explode('?', $requestUri)[0];
+        $action = $this->routes[$requestMethod][$route] ?? null;
+
+        if (! $action) {
+            throw new RouteNotFoundException();
+        }
+
+        if (is_callable($action)) {
+            return call_user_func($action);
+        }
+
+        if (is_array($action)) {
+            [$class, $method] = $action;
+
+            if (class_exists($class)) {
+                $class = new $class();
+
+                if (method_exists($class, $method)) {
+                    return call_user_func_array([$class, $method], []);
+                }
+            }
+        }
+
+        throw new RouteNotFoundException();
+    }
+}

Diff for: app/Router.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+use App\Exceptions\ViewNotFoundException;
+
+class View
+{
+    public function __construct(
+        protected string $view,
+        protected array $params = []
+    ) {
+    }
+
+    public static function make(string $view, array $params = []): static
+    {
+        return new static($view, $params);
+    }
+
+    public function render(): string
+    {
+        $viewPath = VIEW_PATH . '/' . $this->view . '.php';
+
+        if (! file_exists($viewPath)) {
+            throw new ViewNotFoundException();
+        }
+
+        foreach($this->params as $key => $value) {
+            $$key = $value;
+        }
+
+        ob_start();
+
+        include $viewPath;
+
+        return (string) ob_get_clean();
+    }
+
+    public function __toString(): string
+    {
+        return $this->render();
+    }
+
+    public function __get(string $name)
+    {
+        return $this->params[$name] ?? null;
+    }
+}

Diff for: app/View.php

@@ -1,8 +1,14 @@
 {
-  "autoload": {
-    "psr-4": {"App\\": "src/App"}
-  },
-  "require-dev": {
-    "phpunit/phpunit": "9.5"
-  }
+    "require": {
+        "ext-pdo": "*",
+        "vlucas/phpdotenv": "^5.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "App\\": "app/"
+        }
+    },
+    "config": {
+        "optimize-autoloader": true
+    }
 }