Merge pull request #207 from codeigniter4projects/view-objects

View Heroes and Dungeons

Author: lonnieezell

README.md

@@ -1,4 +1,5 @@
 # Playground
+
 A space to learn and experience CodeIgniter 4
 
 [![](https://github.com/codeigniter4projects/playground/workflows/PHPUnit/badge.svg)](https://github.com/codeigniter4projects/playground/actions/workflows/test.yml)
@@ -8,78 +9,84 @@ A space to learn and experience CodeIgniter 4
 
 This playground is here to help you learn CodeIgniter 4 by example. We try to cover use cases for the most
 common tasks you'll find yourself doing in web applications. Where there are multiple ways to do something,
-we've tried to give examples of doing things in each way. 
+we've tried to give examples of doing things in each way.
 
 This isn't meant to replace [the docs](https://codeigniter4.github.io/CodeIgniter4/index.html). This is just
-something to look at to get a deeper understanding, or to better see how something could be done in practice. 
+something to look at to get a deeper understanding, or to better see how something could be done in practice.
 
 ## Resources
 
-There are two primary ways to learn about what's going on here in the Playground. The first is the code itself. 
-We've heaped a LOT of comments throughout the code. They're your best docs. So explore them in depth. 
-Additionally, there's a small collection of docs in the conveniently named [docs](docs) folder. 
+There are two primary ways to learn about what's going on here in the Playground. The first is the code itself.
+We've heaped a LOT of comments throughout the code. They're your best docs. So explore them in depth.
+Additionally, there's a small collection of docs in the conveniently named [docs](docs) folder.
 
-To setup a working playground on your own local device, read through the next section.  
+To setup a working playground on your own local device, read through the next section.
 
-## Getting Started 
+## Getting Started
 
 In order to get the playground setup on your own computer, you'll need a few minimum requirements - all of which
 are listed on [CodeIgniter's repo](https://github.com/codeigniter4/CodeIgniter4#server-requirements). Basically,
-as long as you are running PHP 7.2 or later you'll meet most of them. 
+as long as you are running PHP 7.2 or later you'll meet most of them.
 
-While CodeIgniter does not require it, using this repo also requires the use of 
-[Composer](https://getcomposer.org/) to install CodeIgniter as a dependency, and PHPUnit - the test framework. 
+While CodeIgniter does not require it, using this repo also requires the use of
+[Composer](https://getcomposer.org/) to install CodeIgniter as a dependency, and PHPUnit - the test framework.
 You don't need that installed globally, and we actually recommend against it, since different projects likely
-require different versions of PHPUnit installed as time goes on and it can become tricky maintain a local 
-environment that works with all of the different versions. 
+require different versions of PHPUnit installed as time goes on and it can become tricky maintain a local
+environment that works with all of the different versions.
 
 While it can be downloaded as a zip and extracted, we'll use [git](https://git-scm.com/) to manage things.
 
-With those out of the way, it only takes a few small steps to get the project up and running locally. 
+With those out of the way, it only takes a few small steps to get the project up and running locally.
 
 1 - Clone the repo if you haven't already, from the CLI:
 
-	git clone https://github.com/codeigniter4projects/playground
+    git clone https://github.com/codeigniter4projects/playground
 
 That creates a new directory, `playground`, under your current directory.
 
 2 - Enter the new directory and install the project dependencies with Composer. NOTE: The command shown
 here assumes that you have Composer loaded globally. If you don't, then pretend we're using `composer.phar`.
+
 ```
 cd playground
 composer install
 ```
 
 3 - Copy `.env.example` in the project directory and name it `.env`. Then open it up and verify the settings:
 
-* First, `CI_ENVIRONMENT` is set to `development` as this enables error handling, the debug toolbar, and some other
-	things handy while in development. 
+- First, `CI_ENVIRONMENT` is set to `development` as this enables error handling, the debug toolbar, and some other
+  things handy while in development.
+
+- Next make sure that `app.baseURL` matches whatever you are currently running your site at. If you use `spark`,
+  then it already matches the default. If this doesn't match, then generated links might not work, and your
+  developer toolbar will never show up.
 
-* Next make sure that `app.baseURL` matches whatever you are currently running your site at. If you use `spark`, 
-	then it already matches the default. If this doesn't match, then generated links might not work, and your 
-	developer toolbar will never show up. 
+- Finally while you're in there, you can edit your database settings, though you can do that in `app/Config/Database.php`
+  just as easily. Since we won't deploy this to multiple servers it's no big deal to edit the config files directly.
 
-* Finally while you're in there, you can edit your database settings, though you can do that in `app/Config/Database.php`
-	just as easily. Since we won't deploy this to multiple servers it's no big deal to edit the config files directly.
+4 - Back on the command line, we install all of the needed database tables and sample data.
 
-4 - Back on the command line, we install all of the needed database tables and sample data. 
 ```
 php spark migrate
 php spark db:seed PlaygroundSeeder
 ```
 
 5 - That's it! If you're hosting through Apache, Nginx, etc, then head to your site. If you just want a quick
-way to work with your site locally, go back to the CLI and start up `spark`, CodeIgniter's small server. 
+way to work with your site locally, go back to the CLI and start up `spark`, CodeIgniter's small server.
 
-	php spark serve
+    php spark serve
 
-If you get would like to change the port it's running on, that's no problem: 
+If you get would like to change the port it's running on, that's no problem:
 
-	php spark serve --port 8081
+    php spark serve --port 8081
 
-Enjoy! 
+Enjoy!
 
 ## Code Challenges
 
-There are some portions of the code intentionally left for *you* to finish. Once you are familiar with
+There are some portions of the code intentionally left for _you_ to finish. Once you are familiar with
 the project and have read through the docs try searching the code for anything with the comment **Help!**.
+
+## Images
+
+All images in this repo were created by MidJourney and are can be used freely in non-commercial use cases.

app/Config/Routes.php

@@ -25,7 +25,7 @@
 // where controller filters or CSRF protection are bypassed.
 // If you don't want to define all routes, please use the Auto Routing (Improved).
 // Set `$autoRoutesImproved` to true in `app/Config/Feature.php` and set the following to true.
-$routes->setAutoRoute(true);
+$routes->setAutoRoute(false);
 
 /*
  * --------------------------------------------------------------------
@@ -37,6 +37,9 @@
 // route since we don't have to scan directories.
 $routes->get('/', 'Home::index');
 
+$routes->get('heroes/(:num)', 'HeroController::show/$1');
+$routes->get('dungeons/(:num)', 'DungeonController::show/$1');
+
 /*
  * --------------------------------------------------------------------
  * Additional Routing

app/Controllers/DungeonController.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Controllers;
+
+use App\Controllers\BaseController;
+use App\Models\DungeonModel;
+use App\Models\HeroModel;
+
+class DungeonController extends BaseController
+{
+    /**
+     * HeroModel instance.
+     */
+    protected $heroes;
+
+    public function __construct()
+    {
+        // Assign the model to $this->heroes
+        // so that it's available throughout this class
+        // Use the `model()` helper method to return
+        // a single instance of the model no matter
+        // how many times we call it
+        $this->heroes = model(DungeonModel::class);
+    }
+
+    /**
+     * View a single hero's details.
+     *
+     * The $id parameter is the hero's ID, and is
+     * passed in from the route definition as $1,
+     * since it is the first placeholder in the route.
+     */
+    public function show(int $id)
+    {
+        $dungeon = $this->heroes->find($id);
+
+        if ($dungeon === null) {
+            return redirect()->back()->with('error', 'Dungeon not found');
+        }
+
+        echo view('dungeon', [
+            'dungeon' => $dungeon,
+            'monsters' => $dungeon->monsters(3),
+        ]);
+    }
+}

app/Controllers/HeroController.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Controllers;
+
+use App\Controllers\BaseController;
+use App\Models\HeroModel;
+use CodeIgniter\Exceptions\PageNotFoundException;
+
+class HeroController extends BaseController
+{
+    /**
+     * View a single hero's details.
+     *
+     * The $id parameter is the hero's ID, and is
+     * passed in from the route definition as $1,
+     * since it is the first placeholder in the route.
+     */
+    public function show(int $id)
+    {
+         // When you only need to use a model in a single place,
+         // you can simply get a new instance here. It will use
+         // the default database connection if none is passed in
+        // during instantiation.
+        $heroes = new HeroModel();
+
+        // Locate a single hero, by ID.
+        $hero = $heroes->find($id);
+
+        // If the hero was not located, throw an exception.
+        if ($hero === null) {
+            throw new PageNotFoundException('Hero not found');
+        }
+
+        // Display a view file, passing the variables
+        // you want to access in the view within the
+        // second parameter.
+        echo view('hero', [
+            'hero' => $hero,
+        ]);
+    }
+}

app/Entities/Dungeon.php

@@ -2,6 +2,7 @@
 
 namespace App\Entities;
 
+use App\Models\MonsterModel;
 use CodeIgniter\Entity\Entity;
 
 /**
@@ -34,4 +35,15 @@ public function link(): string
     {
         return site_url("dungeons/{$this->attributes['id']}");
     }
+
+    /**
+     * Use another model to get some random data.
+     */
+    public function monsters(int $limit=5)
+    {
+        return model(MonsterModel::class)
+            ->where('dungeon_id', $this->id)
+            ->orderBy('health', 'asc')
+            ->findAll();
+    }
 }

app/Entities/Monster.php

@@ -3,6 +3,8 @@
 namespace App\Entities;
 
 use CodeIgniter\Entity\Entity;
+use CodeIgniter\HTTP\Exceptions\HTTPException;
+use InvalidArgumentException;
 
 /**
  * Class Monster
@@ -20,6 +22,17 @@ class Monster extends Entity
         'dungeon_id' => 'integer',
     ];
 
+    /**
+     * Entities are the perfect place for
+     * convenience methods made to clean up data.
+     */
+    public function image(): string
+    {
+        $fileName = strtolower($this->name);
+
+        return base_url("images/{$fileName}.png");
+    }
+
     /**
      * Help! Monsters each have their own set of abilities (see Database/Seeds) but
      * our entity has no way of knowing what those are. Can you write it?

app/Views/_monster.php

@@ -0,0 +1,18 @@
+<?php if (! empty($monster)) : ?>
+    <div class="card mb-3" style="max-width: 540px;">
+        <div class="row g-0">
+            <div class="col-md-5">
+                <img src="<?= esc($monster->image(), 'attr') ?>"
+                    class="img-fluid rounded-start"
+                    alt="<?= esc($monster->name) ?>"
+                >
+            </div>
+            <div class="col-md-7">
+                <div class="card-body">
+                    <h5 class="card-title"><?= esc($monster->name) ?></h5>
+                    <p>Health: <?= $monster->health ?? 0 ?></p>
+                </div>
+            </div>
+        </div>
+    </div>
+<?php endif ?>

app/Views/dungeon.php

@@ -0,0 +1,63 @@
+<!--
+    We are using View Layouts to provide a consistent
+    look to the site. The `extend()` method tells the
+    name of the view that this view will work with to
+    display the final content. In this case, the view
+    is at app/Views/layout.php
+-->
+<?= $this->extend('layout') ?>
+
+<!--
+    Everything between `section()` and `endSection()
+    is inserted into the `layout` view where it calls
+    `$this->renderSection('content')`.
+-->
+<?= $this->section('content') ?>
+    <div class="">
+
+        <!-- While we should throw exception if the dungeon is not found,
+                we'll add a check just in case. -->
+        <?php if (empty($dungeon)) : ?>
+            <div class="alert alert-warning">
+                Dungeon not found.
+            </div>
+        <?php endif ?>
+
+        <!-- Dungeon Details -->
+        <?php if ($dungeon) : ?>
+            <div class="container text-center">
+                <div class="col-6 mx-auto">
+
+                    <div class="card shadow">
+                        <img src="<?= base_url('images/dungeon.png') ?>"
+                            alt="<?= esc($dungeon->name, 'attr') ?>"
+                            class="card-img-top"
+                        >
+                        <div class="card-body">
+                            <h5 class="card-title"><?= esc($dungeon->name) ?></h5>
+
+                            <ul class="card-text list-unstyled">
+                                <li>Capacity: <?= esc($dungeon->capacity) ?></li>
+                                <li>Difficulty: <?= esc($dungeon->difficulty) ?></li>
+                            </ul>
+
+                            <br>
+
+                            <h6>Monsters in Residence</h6>
+
+                            <?php foreach($monsters as $monster) : ?>
+                                <!-- It's nice to keep things simple.
+                                    Don't be afraid to use view fragments
+                                    to keep your code clean and readable.
+                                -->
+                                <?= view('_monster', ['monster' => $monster]) ?>
+                            <?php endforeach ?>
+                        </div>
+                    </div>
+
+                </div>
+            </div>
+
+        <?php endif ?>
+    </div>
+<?= $this->endSection() ?>