README

Simple Package PHP for developing web API`s with Kiichi PHP.

Specifications and Dependencies

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

install package

Run the composer command in project root:

composer require devvime/kiichi-php-engine

Configuration

<?php

require_once(__DIR__.'vendor/autoload.php');

use Devvime\Kiichi\Engine\Router;

$router = new Router();

Creating routes

Route and Function

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

Route and Class

Folder structure for using classes

├── src
|  ├── Controllers
│  |  └── ProductController.php
|  |── Models
│  |  └── Product.php
|  |── Middlewares
│  |  └── ExempleMiddleware.php

Class name must contain the word Controller, for example: UserController.php

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

Group of routes and parameters in URL

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

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

Route and Middleware

Middleware Class name must contain the word Middleware, for example: AuthMiddleware.php

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

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

// Middleware Function in Route Group

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

// Middleware Class in Route Group

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

Request data

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

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

Request post data JSON

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

Request params in URL

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

Start routes

$router->run();

Render HTML file

Required Settings

#Views Settings
const VIEWS_DIR = __ROOT__.'/src/Views/';
const VIEWS_CACHE_DIR = __ROOT__.'/src/Views/default/cache/';
const HEADER_DATA = [
  "author" => "Authro here...", 
  "description" => "Description here..."
];
const VERSION = '1.0.0';

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

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

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

$router->get('/user', function($req, $res) use($router) {
    $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

devvime / kiichi-php-engine

Maintainers

Details