Guest List Application¶

This guide will walk you through the creation of a simple guest list application step-by-step. This application allows you to display their details. You will learn the basic functions of the framework and how to use them effectively in your application.

Resources¶

CREATE TABLE `guest` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `first_name` VARCHAR(255) NOT NULL,
    `last_name` VARCHAR(255) NOT NULL,
    `email` VARCHAR(255) NOT NULL.
    `active` TINYINT NOT NULL DEFAULT 1,
    `created` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
);

INSERT INTO `guest` (`first_name`, `last_name`, `email`) VALUES
('Michael', 'Hill', '[email protected]'),
('Julia', 'Conner', '[email protected]'),
('Michael', 'Price', '[email protected]'),
('Kyle', 'Reyes', '[email protected]'),
('Russell', 'Moore', '[email protected]'),
('Jessica', 'Green', '[email protected]'),
('Emily', 'Davis', '[email protected]'),
('Laura', 'Smith', '[email protected]'),
('James', 'Brown', '[email protected]'),
('Emma', 'Johnson', '[email protected]');

Setting up the Database¶

To define the database structure, go to the database/migrations folder. Create a file named [DATE]_guest.sql, replacing [DATE] with the current date in the format YYYY-MM-DD. Then, paste the CREATE TABLE statement from the Resources section into the file.

To add initial data, go to the database/seeds folder. Create a file named guest.sql and paste the INSERT INTO statement from the Resources section.

This separates the database structure and seed data, keeping your setup organized.
While the file names are customizable, it is recommended to follow a clear and consistent naming convention, such as including the date and a descriptive name.

Setting up the Controller¶

To handle all requests, we need to create a Controller. For this example, create a file named GuestsController.php in the z_controllers folder.
The file name, controller name, and action name are flexible but should be chosen for clear, logical understanding and consistency.

<?php
    class GuestsController extends z_controller {

    }
?>

To handle a request, you also need to define a method for the specific action:

<?php
    class GuestsController extends z_controller {

        public function action_list(Request $req, Response $res) {

        }
    }
?>

Setting up the Model¶

To interact with the database where the guests are stored, we need a Model.
For this example, create a file named GuestsModel.php in the z_models folder.
You have flexibility in the naming of the file and model, but it is best to use a clear and logical structure for better understanding.

<?php
    class GuestsModel extends z_model {

    }
?>

<?php
    class GuestsModel extends z_model {
        public function getGuests(): array {
            $sql = "SELECT *
                    FROM `guests`";

            $guestList = $this->exec($sql)->resultToArray();

            return $guestList;
        }
    }
?>

Explanation¶

1. SQL Query: Define the SQL query to retrieve the data.
2. Execute Query: Use the exec function to execute the query.
3. Process Results: Convert the query results into an array with resultToArray.
4. Return Data: Return the guest list for further use.

Connecting the Controller and Model¶

In the controller, call the model method to retrieve the data. Here's how:

<?php
    class GuestsController extends z_controller {

        public function action_list(Request $req, Response $res) {
            $guests = $req->getModel('Guests')->getGuests();
        }
    }
?>

Finally, we need to render a view and pass the guest list to it.

Creating the View¶

To create a view, add a folder named guests in the z_views folder and inside this folder add a file named guests_list.php:

<?php return ["body" => function ($opt) { ?>

<?php }]; ?>

In the controller, render the view like this:

<?php
    class GuestsController extends z_controller {

        public function action_list(Request $req, Response $res) {
            $guests = $req->getModel('Guests')->getGuests();

            return $res->render("guests/guests_list.php", [
                "guests" => $guests
            ]);
        }
    }
?>

Explanation¶

• render: Use this method to render a view file.
• Variables: Pass variables (like the guest list) as the second parameter to make them available in the view.

Displaying Guests in the View¶

Create an HTML table to display the guests, with columns for First Name, Last Name, and Email:

<?php return ["body" => function ($opt) { ?>
    <table>
        <thead>
            <tr>
                <th>First Name</th>
                <th>Last Name</th>
                <th>Email</th>
            </tr>
        </thead>
        <tbody>

        </tbody>
    </table>
<?php }]; ?>

<?php return ["body" => function ($opt) { ?>
    <table>
        <thead>
            <tr>
                <th>First Name</th>
                <th>Last Name</th>
                <th>Email</th>
            </tr>
        </thead>
        <tbody>
            <?php foreach ($opt["guests"] as $guest) { ?>

            <?php } ?>
        </tbody>
    </table>
<?php }]; ?>

<?php return ["body" => function ($opt) { ?>
    <table>
        <thead>
            <tr>
                <th>First Name</th>
                <th>Last Name</th>
                <th>Email</th>
            </tr>
        </thead>
        <tbody>
            <?php foreach ($opt["guests"] as $guest) { ?>
                <tr>
                    <td><?= $guest["first_name"] ?></td>
                    <td><?= $guest["last_name"] ?></td>
                    <td><?= $guest["email"] ?></td>
                </tr>
            <?php } ?>
        </tbody>
    </table>
<?php }]; ?>

Summary¶

• Model: Define the database query in the model.
• Controller: Fetch the data and render the view.
• View: Display the data in an HTML table.

This simple application demonstrates how to connect a model, controller, and view to create a guest list application.
To start your Website run "npm run start" inside your terminal.
And to view your result, navigate to http://localhost:8080/Guests/list in your browser.

Next Guide¶

In the next guide, we’ll take a closer look at how to secure your website using roles and permissions. This is a key step to make sure that only authorized users can access certain features or parts of your application. By setting up roles and assigning specific permissions, you’ll create a solid system to manage access and keep your website both secure and organized.

Library