devvime / initial-dashboard-back

Backend for initial dashboard

Kiichi PHP

Simple Framework PHP MVC for developing web API`s.

---

Specifications and Dependencies

• PHP Version >= 8.1.0
• Composer
• PHPMailer
• Eloquent ORM
• RainTPL 3
• php-jwt
• phpdotenv

install packages

in the root of the project, run the composer command

composer update

---

Routes

The project's routes are located inside the Routes.php file inside the App folder.

├── App
│  └── Routes.php

Configuration

<?php

use App\Core\Application;

$app = new Application();

Creating routes

Route and Function

$app->get('/', function($req, $res) {
    $res->json(['title'=>'Simple CRUD PHP']);
});

Route and Class

$app->get('/:id', 'UserController@find');

Group of routes and parameters in URL

$app->group('/hello', function() use($app) {
    $app->get('/:name', function($req, $res) {
        $res->render('html-file-name', [
            "name"=>$req->params->name            
        ]);
    });
});

$app->group('/user', function() use($app) {
    $app->get('', 'UserController@index');
    $app->get('/:id', 'UserController@find');
    $app->post('', 'UserController@store');
    $app->put('/:id', 'UserController@update');
    $app->delete('/:id', 'UserController@destroy');
});

Route and Middleware

// Middleware in  Function
$app->get('/:id', 'UserController@find', function() {
    // Middleware code...
});

// Middleware in Class
$app->get('/:id', 'UserController@find', 'UserMiddleware@verifyAuthToken');

// Middleware Function in Route Group

$app->group('/user', function() use($app) {
    $app->get('', 'UserController@index');
    $app->get('/:id', 'UserController@find');
    $app->post('', 'UserController@store');
    $app->put('/:id', 'UserController@update');
    $app->delete('/:id', 'UserController@destroy');
}, function() {
    // Middleware code...
});

// Middleware Class in Route Group

$app->group('/user', function() use($app) {
    $app->get('', 'UserController@index');
    $app->get('/:id', 'UserController@find');
    $app->post('', 'UserController@store');
    $app->put('/:id', 'UserController@update');
    $app->delete('/:id', 'UserController@destroy');
}, 'AuthMiddleware@verifyToken');

Request data

Request data in URL Query ex: http://api.server.com/user?name=steve

$app->post('/user', function($req, $res) {
    $name = $req->query->name;
});

Request post data JSON

$app->post('/user', function($req, $res) {
    $name = $req->body->name;
    $email = $req->body->email;
});

Request params in URL

$app->put('/:id', function($req, $res) {
    $id = $req->params->id;
});

Start routes

$app->run();

Create Controller

To create a new controller with the assistant, just type the following command, informing the name of the controller and the name of the database table that will be used -> EX: composer new controller controllerName tableName.

composer new controller product products

Result:

├── App
|  ├── Controllers
│  |  └── ProductController.php
|  |── Models
|  |  └── Products.php

Create Middleware

To create a new middleware with the wizard, just type the following command informing the name of the middleware.

composer new middleware product

Result:

├── App
|  ├── Middlewares
│  |  └── ProductMiddleware.php

Create new email controller

Type the following command informing the name of the mail controller.

composer new mail news

Result:

├── App
|  ├── Controllers
│  |  └── NewsController.php

Render HTML file

To render an HTML file just use $res->render('file-name'); no need to add .html in file name

$app->get('/user', function($req, $res) use($app) {
    $res->render('html-file-name');
});

To render an HTML file by sending an array of data use $res->render('file-name');

$app->get('/user', function($req, $res) use($app) {
    $res->render('html-file-name', [
        "name"=>$user->name,
        "email"=>$user->email,
        "product"=>$productArray
    ]);
});

To receive the data sent to the HTML file use {{ key }} or {{ key.object.name }}

<div class="card">
    <h4>{$name }/h4>
    <p>{$email}</p>
    <hr/>
    <p>{$product.title}</p>
    <p>{$product.description}</p>
    <p>{$product.price}</p>
</div>

For more details, see the documentation at RainTPL 3