mardira framework

Mardira Framework是用於構建Web應用程序和API的PHP框架模型控制器。它設計為簡單，快速。

目錄

• 要求
• 結構文件夾
• 安裝
• 用法
  • 啟動服務器
  • 創建.env
  • 創建控制器
  • 創建模型
  • 創建路線
  • 創建遷移
  • 運行遷移
  • 刷新遷移
  • 刷新種子遷移
  • 創建播種機
  • 運行播種機
  • 特定於播種機
  • 創建身份
  • 刷新身份
  • 更新框架版本
  • 控制器
  • 模型
  • 遷移
  • 播種機
  • 中介軟體
  • 路線
    • 路線組
  • 查詢構建器
    • 選擇
    • 在哪裡
    • 或哪裡
    • 在哪裡
    • 不在哪裡
    • 在哪裡無效
    • 沒有空的地方
    • 訂購
    • 組
    • 加入
    • 插入
    • 更新
    • 刪除
    • 數數

要求

• PHP = 7.4
• mysql> = 5.7.8
• Apache> = 2.4.41
• 作曲家> = 2.0.9

結構文件夾

mardira-framework
├── App
│   ├── Controllers
│   │   ├── AuthController.php
│   ├── Core
│   │   ├── Commands
│   ├── Database
│   │   ├── Migrations
│   │   │   ├── 2023_01_31_xxxxxx_create_table_users.php
│   │   │   ├── 2023_01_31_xxxxxx_create_table_roles.php
│   │   ├── Seeders
│   │   │   ├── GlobalSeeder.php
│   ├── Helpers
│   ├── Middleware
│   ├── Models
│   ├── Packages
│   ├── Routes
│   │   ├── Api.php

安裝

設定

您可以使用作曲家創建一個新項目

composer create-project mardira/mardira-framework < your_project_name >

或者您可以克隆這個項目

複製

• 克隆此存儲庫，使用`git克隆

  git clone https://github.com/Bootcamp-STMIK-Mardira-Indonesia/mardira-framework.git

然後，使用作曲家安裝依賴項

composer install

或者

composer update

用法

啟動服務器

php mardira serve

或者

php mardira serve --port= < your_port >

創建.env

您可以使用命令創建.env文件

php mardira make:env

創建控制器

php mardira make:controller ControllerName

創建模型

php mardira make:model ModelName

創建路線

php mardira make:route route_name --controller=ControllerName

創建遷移

php mardira make:migration create_table_table_name

運行遷移

如果數據庫不存在，將自動從.env創建數據庫

php mardira migrate

刷新遷移

php mardira migrate:refresh

刷新種子遷移

php mardira migrate:refresh --seed

創建播種機

php mardira make:seeder SeederName

運行播種機

php mardira db:seed

特定於播種機

php mardira db:seed --class=SeederName

創建身份

php mardira make:auth

刷新身份

php mardira make:auth --refresh

更新框架版本

php mardira update

控制器

創建控制器使用php mardira make:controller ControllerName ，這是示例控制器

 <?php

namespace App  Controllers ;

use App  Core  Controller ;

class HomeController extends Controller
{
    public function index ()
    {
        $ this -> response ( 200 ,[
            ' message ' => ' Hello World '
        ]);
    }
}

要使用控制器，您可以在App/Routes/Api.php中添加路由

 <?php

use App  Core  Route ;
use App  Controllers  HomeController ;

Route:: get ( ' /home ' , [HomeController::class, ' index ' ]);

回覆

您可以在控制器中使用響應

 $ this -> response ( 200 ,[
    ' message ' => ' Hello World '
]);

返回JSON期望

{
  "message" : " Hello World "
}

另一個響應示例409

 $ this -> response -> json ( 409 ,[
    ' message ' => ' Conflict '
]);

模型

創建模型使用php mardira make:model ModelName ，這是示例模型

 <?php

namespace App  Models ;

use App  Core  Model ;

class User extends Model
{
    protected $ table = ' users ' ;
    protected $ primaryKey = ' id ' ;
}

要使用模型，您可以在App/Controllers/ControllerName.php中添加模型

 <?php

namespace App  Controllers ;

use App  Core  Controller ;
use App  Models  User ;

class HomeController extends Controller
{
    public function index ()
    {
        $ user = User:: all ();

        $ this -> response ( 200 ,[
            ' message ' => ' Hello World ' ,
            ' data ' => $ user
        ]);
    }
}

遷移

創建遷移使用php mardira make:migration create_table_table_name ，這是示例遷移

 <?php

namespace App  Database  Migrations ;

use App  Core  Migration ;

return new class extends Migration
{
    public function up ()
    {
        $ this -> schema -> create ( ' users ' , function ( $ table ) {
            $ table -> increment ( ' id ' );
            $ table -> string ( ' name ' , 50 );
            $ table -> string ( ' email ' , 50 )-> unique ();
            $ table -> string ( ' password ' , 64 );
            $ table -> timestamps ();
        });
    }

    public function down ()
    {
        $ this -> schema -> dropIfExists ( ' users ' );
    }
}

播種機

創建播種機使用php mardira make:seeder SeederName ，這是示例播種機

 <?php

namespace App  Database  Seeders ;

use App  Core  Seeder ;
use App  Core  QueryBuilder as DB ;

class UserSeeder extends Seeder
{
    public function run ()
    {
        $ data = [
            [
                ' name ' => ' Administrator ' ,
                ' username ' => ' admin ' ,
                ' email ' => ' [email protected] ' ,
                ' password ' => password_hash ( ' password ' , PASSWORD_DEFAULT ),
                ' role_id ' => 1 ,
            ],
            [
                ' name ' => ' User ' ,
                ' username ' => ' user ' ,
                ' email ' => ' [email protected] ' ,
                ' password ' => password_hash ( ' password ' , PASSWORD_DEFAULT ),
                ' role_id ' => 2 ,
            ]
        ];
        DB :: table ( ' users ' )-> insert ( $ data );
    }
}

中介軟體

創建中間件使用php mardira make:middleware MiddlewareName ，這是示例中間件

 <?php

namespace App  Middleware ;

use App  Core  Middleware ;
use App  Core  Auth ;

class AuthMiddleware extends Middleware
{
    public function handle ()
    {
        if (Auth:: check ()) {
            return $ next ();
        }
        return $ this -> response ( 401 , [ ' message ' => ' Unauthorized ' ]);
    }
}

要使用中間件，您可以在路線中添加中間件

Router:: get ( ' /schedules ' , [ScheduleController::class, ' index ' ], [AuthMiddleware::class]);

路由

您可以在App/Routes/Api.php中添加路由

 <?php

use App  Core  Route ;

Router:: get ( ' /home ' , [HomeController::class, ' index ' ]);

路線組

您可以在App/Routes/Api.php中添加路由組

 <?php

use App  Core  Route ;


Router:: controller (ProductController::class)-> group ( function () {
    Router:: post ( ' /products/store ' , ' store ' );
});

查詢構建器

 use App  Core  QueryBuilder as DB ;

選擇

 DB :: table ( ' users ' )-> select ( ' name ' , ' email ' )-> get ();

在哪裡

 // equal
DB :: table ( ' users ' )-> where ( ' id ' , 1 )-> get ();

DB :: table ( ' users ' )-> where ( ' id ' , 1 , ' > ' )-> get ();

DB :: table ( ' users ' )-> where ( ' id ' , 1 , ' < ' )-> get ();

DB :: table ( ' users ' )-> where ( ' id ' , 1 , ' >= ' )-> get ();

DB :: table ( ' users ' )-> where ( ' id ' , 1 , ' <= ' )-> get ();

DB :: table ( ' users ' )-> where ( ' id ' , 1 , ' != ' )-> get ();

DB :: table ( ' users ' )-> where ( ' id ' , 1 , ' <> ' )-> get ();

// like

DB :: table ( ' users ' )-> where ( ' name ' , ' admin ' , ' like ' )-> get ();

DB :: table ( ' users ' )-> where ( ' name ' , ' admin ' , ' not like ' )-> get ();

或哪裡

 DB :: table ( ' users ' )-> orWhere ( ' id ' , 1 )-> get ();

DB :: table ( ' users ' )-> orWhere ( ' id ' , 1 , ' > ' )-> get ();

DB :: table ( ' users ' )-> orWhere ( ' id ' , 1 , ' < ' )-> get ();

DB :: table ( ' users ' )-> orWhere ( ' id ' , 1 , ' >= ' )-> get ();

DB :: table ( ' users ' )-> orWhere ( ' id ' , 1 , ' <= ' )-> get ();

DB :: table ( ' users ' )-> orWhere ( ' id ' , 1 , ' != ' )-> get ();

DB :: table ( ' users ' )-> orWhere ( ' id ' , 1 , ' <> ' )-> get ();

在哪裡

 DB :: table ( ' users ' )-> whereIn ( ' id ' , [ 1 , 2 , 3 ])-> get ();

DB :: table ( ' users ' )-> whereNotIn ( ' id ' , [ 1 , 2 , 3 ])-> get ();

不在哪裡

 DB :: table ( ' users ' )-> whereNotIn ( ' id ' , [ 1 , 2 , 3 ])-> get ();

在哪裡無效

 DB :: table ( ' users ' )-> whereNull ( ' id ' )-> get ();

沒有空的地方

 DB :: table ( ' users ' )-> whereNotNull ( ' id ' )-> get ();

訂購

 DB :: table ( ' users ' )-> orderBy ( ' id ' , ' desc ' )-> get ();

DB :: table ( ' users ' )-> orderBy ( ' id ' , ' asc ' )-> get ();

加入表

 DB :: table ( ' users ' )
    -> join ( ' roles ' , ' users.role_id ' , ' = ' , ' roles.id ' )
    -> select ( ' users.* ' , ' roles.name as role_name ' )
    -> get ();

組

 DB :: table ( ' users ' )
    -> groupBy ( ' role_id ' )
    -> get ();

插入

 DB :: table ( ' users ' )-> insert ([
    ' name ' => ' user ' ,
    ' email ' => ' [email protected] ' ,
    ' password ' => password_hash ( ' password ' , PASSWORD_DEFAULT ),
]);

更新

 DB :: table ( ' users ' )-> where ( ' id ' , 1 )-> update ([
    ' name ' => ' user ' ,
    ' email ' => ' [email protected] ' ,
]);

刪除

 DB :: table ( ' users ' )-> where ( ' id ' , 1 )-> delete ();

數數

 DB :: table ( ' users ' )-> count ();

支持

在以下一個地方之一與我聯繫！

• 網站在demostmikmi.com