phpeasy

مرحبا بكم في phpeasy

Phpeasy هو إطار PHP المتمحور حول API. رمز بالقرب من لغة PHP نفسها بدلاً من إطار عمل.

سمات

1. الراحة تطوير API
2. تطوير تطبيق الويب الكامل
3. التوجيه المستند إلى الملف
4. خفيفة الوزن ، لا يوجد الكثير من التبعيات والتكوينات
5. طبقة تجريد قاعدة البيانات البسيطة
6. وظائف المساعد مثل مصلحة الإدخال ، مولد الرمز ، ملف التحميل ، إلخ.
7. يعزز UBT غير مقصود على البرمجة الإجرائية
8. يدعم PHP 8 وما فوق ، MySQL و MSSQL و SQLite
9. يتضمن CSS الأساسي (Mystyle.css) ومكتبة الأداة المساعدة JS (Vanscript.JS).

النقاط الرئيسية

1. يعزز لإتقان لغة PHP نفسها بدلاً من إطار عمل.
2. مباشرة إلى ترميز النقطة ، لا يوجد الكثير من التجريدات.
3. استخدام طبقة تجريد البيانات بدلاً من ORM ، يركز على أقصى أداء دون مكالمات قاعدة البيانات الكبيرة التي تستخدمها ORMS.

جدول المحتويات

I. مقدمة

الثاني. المتطلبات المسبقة

ثالثا. تثبيت

1. وجهات النظر
2. واجهات برمجة التطبيقات
3. وظائف API
4. العمل مع قاعدة البيانات
5. تقدمية
6. إضافي

مقدمة

هذا لشخص يحب الفانيليا PHP وبساطته. في الوقت الحاضر ، يجب اتباع معايير الترميز (OOP ، الصلبة ، الجافة ، إلخ.) وأطر MVC للقيام بتطوير الويب باستخدام PHP. يأتي PHP Frameworks مع الكثير من الملفات والتكوينات والفئات والتبعيات. لقد صنعت هذا الإطار المصغر حتى يتمكن مطورو PHP من القيام بتطوير الويب بشكل أسرع أثناء إتقان لغة PHP نفسها (نعم! لا حاجة لتعلم الكثير من المكتبات).

المتطلبات المسبقة

1. PHP 8^.
2. الملحن.

تثبيت

الملحن - افتح محطة داخل مجلد الجذر أو HTDOCS وتنفيذ الأمر أدناه.

 composer create-project vgalvoso/phpeasy my_phpeasy

يمكنك تغيير [my_phpeasy] إلى أي اسم مشروع تريده.

افتح الآن متصفحك وانتقل إلى http: // localhost/my_phpeasy

1. وجهات النظر

إنشاء طرق عرض داخل مجلد عرض.

سيتم إنشاء طرق العرض تلقائيًا بناءً على بنية مجلد العرض.

انظر إلى الأمثلة أدناه.

1. عرض مسار الملف: [View/Admin/Dashboard.php] ، المسار: ["Admin/Dashboard"].
2. عرض مسار الملف: [عرض/login.php] ، المسار: ["تسجيل الدخول"].

يمكنك ommit اسم الملف إذا تم تسمية ملف العرض [index.php]:

1. عرض مسار الملف: [عرض/index.php] ، المسار: [""].
2. عرض مسار الملف: [View/Admin/Index.php] ، المسار: ["المسؤول"].

1.1 عرض المكونات

(SPA) تتكون تطبيقات صفحة واحدة من مكونات العرض.

لا يمكن الوصول إلى مكونات العرض إلا من خلال طلبات AJAX.

فقط استدعاء core/helper/component () ؛ في أعلى ملف العرض لتحديده كمكون عرض.

مثال: عرض/مسؤول/مستخدمون

 < ?= 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 وتطبيقها داخل ملف PHP المسمى مع HTTP VERBS على سبيل المثال (GET () ، post () ، patch ()).

على سبيل المثال ، قمت بحذف وظيفة DELETE () ، لا يمكنك الاتصال بحذف API/USERS/{id}.

فيما يلي مثال على واجهة برمجة تطبيقات REST للمستخدمين.

مسار ملف API: [API/user.php]

الطرق:

1. احصل على واجهة برمجة التطبيقات/المستخدمين - احصل على جميع المستخدمين
2. احصل على واجهة برمجة التطبيقات/المستخدمين/{id} - احصل على المستخدم بالمعرف
3. بعد واجهة برمجة التطبيقات/المستخدمين - قم بإنشاء مستخدم جديد
4. حذف API/المستخدمين/{id} - حذف مستخدم
5. ضع واجهة برمجة التطبيقات/المستخدمين/{id} - استبدل المستخدم
6. تصحيح API/المستخدمين/{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

تشجع واجهات برمجة التطبيقات في phpeasy أسلوب الترميز الإجرائي ،

لذا ، إليك قائمة الوظائف التي يمكنك استخدامها في تطبيقات API:

3.3 Startapi

تهيئة ملف PHP كأبي راحة.

بعد استدعاء هذه الوظيفة ، يمكنك تنفيذ أفعال HTTP كدالة.

مثال:

 <?php
use function Core  Helper  startAPI ;

startAPI ();

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

سيتم استلام استجابة الخطأ إذا حاولت طلب استخدام أساليب HTTP بخلاف Get.

3.4 getRequestbody

احصل على طلب الجسم وتحويله إلى صفيف ASSC.

مثال:

 <?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 ، $ _ post).
• $inputs - صفيف الترابط الذي يمكن التحقق منه.
• $validations - مجموعة نقاطية تحتوي على مفاتيح تتطابق مع بيانات وقيم $ هي قواعد التحقق من الصحة.

مثال:

 <?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 - سلسلة | رسالة خطأ صفيف

3.7 استجابة (سلسلة | Array $ محتوى ، int $ statusCode = 200 ، string $ contentType = 'Application/JSON')

اضبط نوع المحتوى ورمز الحالة ثم إخراج المحتوى والخروج من البرنامج النصي

• $content String | Array - المحتوى للإخراج
• $statusCode int - رمز حالة الاستجابة (افتراضي 200)
• $contentType String - نوع المحتوى (التطبيق الافتراضي/JSON). أنواع المحتوى المتاحة: [Application/JSON | عادي/نص | النص/HTML]

3.8 إلى (طريق $)

تضمين عرض محدد

• $route string - عرض مسار الملف

يستخدم في الغالب لمكون SPA مكون

3.9 إعادة التوجيه ($ path = "")

إعادة التوجيه إلى عرض محدد.

إذا لم يتم تحديد المسار ، فقم بإعادة التوجيه بناءً على الجلسة.

• $view السلسلة - المسار للعرض

3.10 ESC ($ string)

بناء جملة أقصر لـ HTMLSpecialChars ()

• $string - سلسلة للتطهير
• استخدامه لتطهير HTML.

3.11 cenerateCode (طول $ = 6)

توليد رمز أبجدي رقمي عشوائي

• $length - طول الكود المراد إنشاءه (افتراضي 6)

3.12 ObjectTosession (كائن $)

استخراج مفاتيح الكائنات والقيم وتخزينها إلى صفيف الجلسة

• $object - الكائن لاستخراج مثال:

 <?php
use Core  DAL ;

$ db = new DAL ();

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

objToSession ( $ userInfo );

3.13 التحميل ($ UploadFile ، $ UploadPath)

إنشاء اسم ملف جديد وتحميل الملف

• string $uploadFile $ _file مفتاح

• يجب إضافة موقع string $uploadPath للحصول على ملف التحميل "/" إلى النهاية
• إرجاع Boolean | سلسلة اسم الملف الجديد إذا نجحت ، خطأ خلاف ذلك

3.14 جلسة ($ sessionvar ، $ value = null)

الحصول على/تعيين متغير جلسة

• $sessionVar - مفتاح الجلسة
• $value - تعيين قيمة جلسة إذا كانت فارغة

3.15 objarraytovalues ​​($ objarr ، $ item)

قم بتحويل مجموعة من الكائنات إلى صفيف مفهرس تحتوي على قيم عنصر محدد.

• $objArr - Array If Icjects للتحويل
• $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 تحديث

ينفذ بيان التحديث

• string $table الجدول للتحديث
• شروط string $condition على سبيل المثال. معرف =: معرف
• array $values صفيف الترابط الذي يحتوي على قيم لتحديث على سبيل المثال. ["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 and name =: name
• array $params قيم الشروط على سبيل المثال. ["id" => 1 ، "name" => "Juan Dela Cruz"]
• العودة المنطقية

مثال:

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

4.5 getItems

حدد عناصر متعددة

• string $query select
• المعلمات 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 select
• المعلمات 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 الالتزام ()

ارتكاب معاملة قاعدة البيانات.

• ضع هذا قبل إعادة الرد في API.

4.9 التراجع ()

معاملة قاعدة البيانات التراجع.

• نادراً ما تستخدم لأنه عند الخروج من البرنامج النصي دون استدعاء الالتزام () ،
• سيتم تنفيذ Rollback () تلقائيًا.

4.10 geterror ()

إرجاع أخطاء قاعدة البيانات

• أداة تصحيح أخطاء مفيدة للغاية.

4.11 LastId ($ حقل = فارغ)

احصل على إدراج LastId على قاعدة البيانات

• string $field حدد حقلًا الأخير ، الافتراضي الفارغ

4.12 getDriver ()

احصل على قاعدة البيانات التي يتم استخدامها حاليًا.

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

$usersList = $users->getAll();

يمكنك استخدام النماذج أو لا اعتمادًا على متطلبات المشروع.

يمكن الوصول إلى فئة DAL مباشرة في ملفات API ، يمكنك تنفيذ استعلام مباشرة على تطبيق API دون إنشاء نموذج.

5. تقدمية

Phpeasy تقدمي ، يمكنك إضافة نماذج أو خدمات إذا أردت ، ما عليك سوى تحديث ملف Composer.json إذا قمت بإضافة دليل آخر.

6. الإضافات

يرى

• مساعدو JS: Public/JS/Vanscript.js
• CSS: Public/CSS/Mystyle.css