Simple Framework PHP MVC for developing web API`s.
in the root of the project, run the composer command
composer update
The project's routes are located inside the Routes.php file inside the src folder.
├── src
│ └── routes.php
<?php
use Devvime\Kiichi\Engine\Router;
$router = new Router();Route and Function
$router->get('/', function($req, $res) {
$res->json(['title'=>'Simple CRUD PHP']);
});Route and Class
$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 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 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();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:
├── src
| ├── Controllers
│ | └── ProductController.php
| |── Models
| | └── Products.php
To create a new middleware with the wizard, just type the following command informing the name of the middleware.
composer new middleware product
Result:
├── src
| ├── Middlewares
│ | └── ProductMiddleware.php
Type the following command informing the name of the mail controller.
composer new mail news
Result:
├── src
| ├── Controllers
│ | └── NewsController.php
To create a new migration, simply type the following command in the project root (use CamelCase format):
composer new-migration MyMigration
Result:
├── src
| ├── Database
| | ├── Migrations
│ | └── 20240311052948_MyMigration.php
Migration code:
<?php
declare(strict_types=1);
use Phinx\Migration\AbstractMigration;
final class MyMigration extends AbstractMigration
{
public function change(): void
{
}
}Example to create table:
<?php
declare(strict_types=1);
use Phinx\Migration\AbstractMigration;
final class MyMigration extends AbstractMigration
{
public function change(): void
{
$table = $this->table('table-name');
$table->addColumn('name', 'string')
->addColumn('description', 'text')
->addColumn('files', 'json')
->addColumn('amount', 'json')
->create();
}
}More information on writing migrations is available here: https://book.cakephp.org/phinx/0/en/migrations.html#the-change-method
After configuring database access in the .ENV file and having a database created, simply enter this command to run the migrations and create the tables:
composer migrate
To undo the migration changes you made, simply run this command:
composer rollback
To create a new seed, simply type the following command in the project root (use CamelCase format):
composer new-seed MySeed
Result:
├── src
| ├── Database
| | ├── Seeds
│ | └── MySeed.php
Seed code:
<?php
declare(strict_types=1);
use Phinx\Seed\AbstractSeed;
class MySeed extends AbstractSeed
{
public function run(): void
{
}
}Seed example:
<?php
declare(strict_types=1);
use Phinx\Seed\AbstractSeed;
class MySeed extends AbstractSeed
{
public function run(): void
{
$data = [
[
'name' => 'Notebook',
'description' => 'Lorem Ipsum is simply dummy, Lorem Ips incorrectly asserts that Lorem Ips correctly asserts.',
'price' => 1999
],
[
'name' => 'Monitor',
'description' => 'Lorem Ips incorrectly asserts that Lorem Ips correctly asserts.',
'price' => 599
]
];
$products = $this->table('products');
$products->insert($data)->save();
}
}More information on writing seeders is available here: https://book.cakephp.org/phinx/0/en/seeding.html
After configuring database access in the .ENV file and having a database created, simply enter this command to run the seed and create data in table:
composer run-seed
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