phpeasy

ยินดีต้อนรับสู่ phpeasy

PHPEASY เป็นเฟรมเวิร์ก PHP ที่เน้น API รหัสใกล้เคียงกับภาษา PHP เองแทนที่จะเป็นกรอบ

คุณสมบัติ

1. การพัฒนา REST API
2. การพัฒนาแอพพลิเคชั่นเว็บเต็มซ้อน
3. การกำหนดเส้นทางตามไฟล์
4. น้ำหนักเบาไม่มีการพึ่งพาและการกำหนดค่ามากเกินไป
5. เลเยอร์นามธรรมฐานข้อมูลอย่างง่าย
6. ฟังก์ชั่นผู้ช่วยเช่นตัวตรวจสอบอินพุตตัวสร้างรหัสอัปโหลดไฟล์ ฯลฯ
7. ส่งเสริม UBT ที่ไม่ได้ถูก จำกัด อยู่ในการเขียนโปรแกรมขั้นตอน
8. รองรับ PHP 8 ขึ้นไป, MySQL, MSSQL และ SQLITE
9. รวมถึง CSS พื้นฐาน (mystyle.css) และ JS (vanscript.js) ห้องสมุดยูทิลิตี้

ประเด็นหลัก

1. ส่งเสริมให้เชี่ยวชาญภาษา PHP เองแทนที่จะเป็นกรอบ
2. ตรงไปที่การเข้ารหัสจุดไม่มี abstractions มากเกินไป
3. การใช้เลเยอร์ข้อมูลที่เป็นนามธรรมมากกว่า ORM มุ่งเน้นไปที่ประสิทธิภาพสูงสุดโดยไม่มีการโทรฐานข้อมูลขนาดใหญ่ที่ ORM ใช้

สารบัญ

I. อินโทร

ii. สิ่งที่ต้องมีก่อน

iii. การติดตั้ง

1. มุมมอง
2. APIs
3. ฟังก์ชั่น API
4. ทำงานกับฐานข้อมูล
5. ซึ่งมีความก้าวหน้า
6. พิเศษ

อินโทร

นี่คือสำหรับคนที่รักวานิลลา PHP และความเรียบง่าย ทุกวันนี้คุณต้องปฏิบัติตามมาตรฐานการเข้ารหัส (OOP, Solid, Dry, ฯลฯ ) และ MVC Frameworks เพื่อทำการพัฒนาเว็บโดยใช้ PHP เฟรมเวิร์ก PHP ออกมาพร้อมกับไฟล์การกำหนดค่าคลาสและการพึ่งพามากเกินไป ฉันทำมินิเฟรมเวิร์กนี้เพื่อให้นักพัฒนา PHP สามารถพัฒนาเว็บได้เร็วขึ้นในขณะที่เรียนรู้และเพลิดเพลินกับภาษา PHP เอง (ใช่! ไม่จำเป็นต้องเรียนรู้ห้องสมุดมากมาย)

สิ่งที่ต้องมีก่อน

1. Php 8^
2. นักแต่งเพลง

การติดตั้ง

นักแต่งเพลง - เปิดเทอร์มินัลภายในโฟลเดอร์รูทหรือ HTDOCS ของคุณและดำเนินการคำสั่งด้านล่าง

 composer create-project vgalvoso/phpeasy my_phpeasy

คุณสามารถเปลี่ยน [my_phpeasy] เป็นชื่อโครงการใด ๆ ที่คุณต้องการ

ตอนนี้เปิดเบราว์เซอร์ของคุณและไปที่ http: // localhost/my_phpeasy

1. มุมมอง

สร้างมุมมองภายในโฟลเดอร์ View

ดูเส้นทางจะถูกสร้างขึ้นโดยอัตโนมัติตามโครงสร้างมุมมองโฟลเดอร์

ดูตัวอย่างด้านล่าง

1. ดูเส้นทางไฟล์: [ดู/admin/dashboard.php], เส้นทาง: ["ผู้ดูแลระบบ/แดชบอร์ด"]
2. ดูเส้นทางไฟล์: [view/login.php], เส้นทาง: ["เข้าสู่ระบบ"]

คุณสามารถ ommit ชื่อไฟล์ได้หากไฟล์มุมมองชื่อ [index.php]:

1. ดูเส้นทางไฟล์: [view/index.php], เส้นทาง: [""]
2. ดูเส้นทางไฟล์: [ดู/admin/index.php], เส้นทาง: ["admin"]

1.1 ดูส่วนประกอบ

(SPA) แอปพลิเคชันหน้าเดียวประกอบด้วยส่วนประกอบมุมมอง

ส่วนประกอบดูสามารถเข้าถึงได้ผ่านคำขอ AJAX เท่านั้น

เพียงแค่เรียก Core/Helper/Component (); ที่ด้านบนของไฟล์มุมมองเพื่อระบุเป็นส่วนประกอบมุมมอง

ตัวอย่าง: ดู/admin/users_table.php

 < ?= Core/Helper/component(); ? >
< table >
    < thead >
        < tr >
            < th > Username </ th >
            < th > First Name </ th >
            < th > Last Name </ th >
        </ tr >
    </ thead >
    < tbody id =" users_tbl " >
        < tr > < td > No Contents </ td > </ tr >
    </ tbody >
</ table > 

2. APIS

PHPEASY รองรับ REST API

API ทั้งหมดจะถูกวางไว้ในโฟลเดอร์ API

เส้นทาง API จะสร้างขึ้นโดยอัตโนมัติผ่านโครงสร้างไฟล์โฟลเดอร์ API และฟังก์ชั่นที่ใช้งานภายในไฟล์ PHP ที่ชื่อพร้อมคำกริยา HTTP เช่น (get (), post (), patch ())

ตัวอย่างเช่นคุณละเว้นฟังก์ชั่น DELETE () คุณไม่สามารถเรียก DELETE API/users/{id}

นี่คือตัวอย่างของผู้ใช้ REST API

เส้นทางไฟล์ API: [API/users.php]

เส้นทาง:

1. รับ API/ผู้ใช้ - รับผู้ใช้ทั้งหมด
2. รับ api/users/{id} - รับผู้ใช้โดย id
3. โพสต์ API/ผู้ใช้ - สร้างผู้ใช้ใหม่
4. ลบ API/ผู้ใช้/{id} - ลบผู้ใช้
5. ใส่ api/users/{id} - แทนที่ผู้ใช้
6. Patch API/users/{id} - อัปเดตผู้ใช้

 <?php

use Core  DAL ;

use function Core  Helper  error ;
use function Core  Helper  getRequestBody ;
use function Core  Helper  response ;
use function Core  Helper  startAPI ;

startAPI ();

function get (){
    $ db = new DAL ();
    //GET user by id
    if ( defined ( ' URI_PARAM ' )){
        $ query = " SELECT * FROM users WHERE id = :id " ;
        $ param = [ " id " => URI_PARAM ];
        if (! $ user = $ db -> getItem ( $ query , $ param ))
            response ([]);
        response ([ $ user ]);
    }
    //GET All users
    $ query = " SELECT * FROM users " ;
    $ users = $ db -> getItems ( $ query );
    response ( $ users );
}

function post (){
    $ db = new DAL ();
    $ rq = ( object ) getRequestBody ();
    $ values = [
        " username " => $ rq -> username ,
        " firstname " => $ rq -> firstname ,
        " lastname " => $ rq -> lastname ,
        " usertype " => $ rq -> usertype ,
        " password " => password_hash ( $ rq -> password , PASSWORD_BCRYPT )
    ];
    if (! $ db -> insert ( " users " , $ values ))
        error ( $ db -> getError ());
    response ( " New User added! " );
}

function delete (){
    if (! defined ( ' URI_PARAM ' ))
        error ( " Invalid Request! Please specify user id " );
    $ db = new DAL ();
    $ id = URI_PARAM ;
    if (! $ db -> delete ( " users " , " id=:id " ,[ " id " => $ id ]))
        error ( $ db -> getError ());
    response ( " User Deleted Successfuly! " );
}

function patch (){
    if (! defined ( ' URI_PARAM ' ))
        error ( " Invalid Request! Please specify user id " );
    $ db = new DAL ();
    $ id = URI_PARAM ;
    $ rq = ( object ) getRequestBody ();
    $ values = [
        " firstname " => $ rq -> firstname ,
        " lastname " => $ rq -> lastname ];
    $ params = [ " id " => $ id ];

    $ db = new DAL ();

    if (! $ db -> update ( " users " , " id=:id " , $ values , $ params ))
        error ( $ db -> getError ());
    response ( " User Updated Successfuly " );
}

//EOF 

3. ฟังก์ชั่น API

APIs ใน phpeasy ส่งเสริมรูปแบบการเข้ารหัสขั้นตอน

ดังนั้นนี่คือรายการของฟังก์ชั่นที่คุณสามารถใช้ในการใช้งาน API:

3.3 startapi

เริ่มต้นไฟล์ PHP เป็น REST API

หลังจากเรียกฟังก์ชั่นนี้แล้วคุณสามารถใช้คำกริยา HTTP เป็นฟังก์ชั่น

ตัวอย่าง:

 <?php
use function Core  Helper  startAPI ;

startAPI ();

function get (){
    //Handle GET request to api/users
}

การตอบกลับข้อผิดพลาดจะได้รับหากคุณพยายามขอโดยใช้วิธี HTTP นอกเหนือจาก GET

3.4 getRequestbody

รับการร้องขอร่างกายและแปลงเป็นอาร์เรย์ Assoc

ตัวอย่าง:

 <?php
use Core  Helper  getRequestBody ;

$ rq = getRequestBody ();
$ username = $ rq [ " username " ];
$ password = $ rq [ " password " ];
//you can convert it to object for easy access
//$rq = (object)$rq;
//$username = $rq->username;
//$password = $rq->password; 

3.5 ตรวจสอบ ($ อินพุต, $ การตรวจสอบ)

ตรวจสอบอาร์เรย์คู่คีย์-ค่าตามกฎการตรวจสอบความถูกต้อง

• ส่งคืนจริงถ้าถูกต้อง, ออกและส่งคืนรหัสสถานะ 400 และรายละเอียดข้อผิดพลาดหากไม่
• ใช้เพื่อตรวจสอบข้อมูลคำขอ ($ _get, $ _ โพสต์)
• $inputs - อาร์เรย์เชื่อมโยงที่จะตรวจสอบ
• $validations - อาร์เรย์เชื่อมโยงที่มีคีย์ที่ตรงกับคีย์ใน $ data และค่าเป็นกฎการตรวจสอบความถูกต้อง

ตัวอย่าง:

 <?php
use function Core  Helper  getRequestBody ;
use function Core  Validator  validate ;

$ rq = getRequestBody ();
$ dataRules = [ " uname " => " required|string " ,
    " upass " => " required|string " ,
    " firstName " => " required|string " ,
    " lastName " => " required|string " ];
validate ( $ rq , $ dataRules );

3.6 ข้อผิดพลาด (สตริง | ข้อความอาร์เรย์ $)

การตอบกลับเอาต์พุตด้วยรหัสสถานะ 400 และข้อความแสดงข้อผิดพลาด

• $message - String | ข้อความแสดงข้อผิดพลาดอาร์เรย์

3.7 การตอบสนอง (สตริง | เนื้อหาอาร์เรย์ $, int $ statusCode = 200, สตริง $ contentType = 'แอปพลิเคชัน/json')

ตั้งค่าประเภทเนื้อหาและรหัสสถานะจากนั้นเอาต์พุตเนื้อหาและออกจากสคริปต์

• $content | อาร์เรย์ - เนื้อหาที่จะส่งออก
• $statusCode Int - รหัสสถานะการตอบกลับ (ค่าเริ่มต้น 200)
• $contentType String - ประเภทเนื้อหา (แอปพลิเคชันเริ่มต้น/JSON) ประเภทเนื้อหาที่มีอยู่: [แอปพลิเคชัน/JSON | ธรรมดา/ข้อความ | ข้อความ/html]

3.8 ถึง ($ ROUTE)

รวมมุมมองที่ระบุ

• $route String - View File Path

ส่วนใหญ่ใช้สำหรับการโทรส่วนประกอบสปา

3.9 เปลี่ยนเส้นทาง ($ path = "")

เปลี่ยนเส้นทางไปยังมุมมองที่ระบุ

หากไม่ได้ระบุเส้นทางให้เปลี่ยนเส้นทางตามเซสชัน

• $view String - Path to View

3.10 ESC ($ String)

ไวยากรณ์ที่สั้นกว่าสำหรับ htmlspecialchars ()

• $string - String to Sanitize
• ใช้สำหรับการฆ่าเชื้อ HTML

3.11 GenerAtecode ($ length = 6)

สร้างรหัสตัวอักษรและตัวเลขแบบสุ่ม

• $length - ความยาวของรหัสที่จะสร้าง (ค่าเริ่มต้น 6)

3.12 ObjectTosession ($ OBJECT)

แยกคีย์วัตถุและค่าและจัดเก็บไปยังอาร์เรย์เซสชัน

• $object - วัตถุที่จะแยกตัวอย่าง:

 <?php
use Core  DAL ;

$ db = new DAL ();

if (! $ user = $ db -> getItem ( 1 ))
    invalid ( " User does not exist! " );

objToSession ( $ userInfo );

3.13 UploadFile ($ uploadfile, $ uploadPath)

สร้างชื่อไฟล์ใหม่และอัปโหลดไฟล์

• string $uploadFile $ _file

• string $uploadPath ตำแหน่งสำหรับไฟล์อัปโหลดต้องเพิ่ม "/" ในตอนท้าย
• ส่งคืนบูลีน | สตริงชื่อไฟล์ใหม่ถ้าสำเร็จ

3.14 เซสชัน ($ sessionVar, $ value = null)

รับ/ตั้งค่าตัวแปรเซสชัน

• $sessionVar - คีย์เซสชัน
• $value - ตั้งค่าเซสชันถ้าเป็นโมฆะ

3.15 objarraytovalues ​​($ objarr, $ item)

แปลงอาร์เรย์ของวัตถุเป็นอาร์เรย์ที่จัดทำดัชนีที่มีค่าของรายการที่ระบุ

• $objArr - อาร์เรย์ถ้า iBjects เพื่อแปลง
• $item - รายการวัตถุเพื่อแยก

4. การทำงานกับฐานข้อมูล

PHPEASY แนะนำคลาส DAL () สำหรับการดำเนินการฐานข้อมูล รองรับ MySQL, MSSQL และ SQLITE

ตั้งค่าการกำหนดค่าฐานข้อมูลใน config/database.php

ด้านล่างเป็นฟังก์ชั่น dal ()

4.1 เริ่มต้น

 $ db = new DAL ();

4.2 แทรก

ดำเนินการคำสั่งแทรก;

• $table - ชื่อตารางที่จะแทรก
• $values - อาร์เรย์เชื่อมโยงที่มีคีย์ที่ตรงกับฟิลด์ตารางและค่าที่จะแทรก
• ส่งคืนบูลีน

ตัวอย่าง:

 $ values = [ " username " => $ uname ,
    " password " => $ upass ,
    " firstname " => $ firstName ,
    " lastname " => $ lastName ];
$ db -> insert ( " users " , $ values );

4.3 อัปเดต

เรียกใช้คำสั่ง UPDATE

• string $table ตารางเพื่ออัปเดต
• string $condition เงื่อนไขเช่น id =: id
• array $values ​​ARRAY ARRAY ที่มีค่าเพื่ออัปเดตเช่น ["age" => 27]
• ค่า array $params สำหรับเงื่อนไขเช่น ["id" => 1]
• คืนบูลีน

ตัวอย่าง:

 $ values = [
    " firstname " => $ firstName ,
    " lastname " => $ lastName ];
$ params = [ " id " => 1 ];

$ db = new DAL ();

$ db -> update ( " users " , " id=:id " , $ values , $ params );

4.4 ลบ

ดำเนินการคำสั่งลบ

• string $table ตารางที่จะลบจาก
• เงื่อนไข string $condition เงื่อนไขโดยใช้คำสั่งที่เตรียมไว้เช่น id =: id และชื่อ =: ชื่อ
• ค่า array $params สำหรับเงื่อนไขเช่น ["id" => 1, "name" => "Juan dela cruz"]
• คืนบูลีน

ตัวอย่าง:

 $ delete ( " users " , " id=:id " ,[ " id " => 1 ]);

4.5 getItems

เลือกหลายรายการ

• คำสั่ง string $query เลือก
• array $inputs อินพุตสำหรับคำสั่งที่เตรียมไว้ (NULL)
• อาร์เรย์ส่งคืน | เท็จ

ตัวอย่าง:

 $ db = new DAL ();

$ sql = " SELECT * FROM users WHERE lastname = :surname " ;
$ params = [ " surname " => $ lastName ];

$ users = $ db -> getItems ( $ sql , $ params );

4.6 getItem

เลือกแบบสอบถามแถวเดียว

• คำสั่ง string $query เลือก
• array $inputs อินพุตสำหรับคำสั่งที่เตรียมไว้ (NULL)
• กลับวัตถุ | เท็จ

ตัวอย่าง:

 $ db = new DAL ();

$ sql = " SELECT * FROM users WHERE id=:userId " ;
$ params = [ " userId " => 1 ];

$ users = $ db -> getItem ( $ sql , $ params );

4.7 StartTrans ()

เริ่มธุรกรรมฐานข้อมูล

4.8 commit ()

ทำธุรกรรมฐานข้อมูล

• วางสิ่งนี้ก่อนที่จะส่งคืนการตอบกลับใน API

4.9 ย้อนกลับ ()

ธุรกรรมฐานข้อมูลย้อนกลับ

• ไม่ค่อยได้ใช้เพราะเมื่อคุณออกจากสคริปต์โดยไม่ต้องโทรไปที่ commit ()
• Rollback () จะถูกดำเนินการโดยอัตโนมัติ

4.10 Geterror ()

ส่งคืนข้อผิดพลาดของฐานข้อมูล

• เครื่องมือการดีบักที่มีประโยชน์มาก

4.11 LastId ($ field = null)

รับ LastId แทรกลงในฐานข้อมูล

• string $field ระบุฟิลด์ LastID, ค่าเริ่มต้น NULL

4.12 getDriver ()

รับ Friver ฐานข้อมูลที่ใช้อยู่ในปัจจุบัน

 - api/getAllUser.php
```php
<?php
$db = new DAL();
$users = new Users($db);

$usersList = $users->getAll();

คุณสามารถใช้โมเดลหรือไม่ได้ขึ้นอยู่กับข้อกำหนดของโครงการ

คลาส DAL สามารถเข้าถึงได้โดยตรงในไฟล์ API คุณสามารถเรียกใช้การสืบค้นโดยตรงเกี่ยวกับการใช้งาน API โดยไม่ต้องสร้างแบบจำลอง

5. ก้าวหน้า

PHPEASY ก้าวหน้าคุณสามารถเพิ่มรุ่นบริการถ้าคุณต้องการเพียงอัปเดตไฟล์ Composer.json หากคุณเพิ่มไดเรกทอรีอื่น ๆ

6. ความพิเศษ

ดู

• ผู้ช่วย JS: สาธารณะ/js/vanscript.js
• CSS: สาธารณะ/css/mystyle.css