ruta

روتا

مكتبة توجيه HTTP خفيفة الوزن لـ PHP. (WIP)

سمات

• رموز حالة HTTP
• أساليب HTTP
• رؤوس HTTP
• طلبات HTTP
  • التعامل مع multipart/form-data data
  • التعامل مع بيانات طلب x-www-form-urlencoded
  • التعامل مع بيانات الطلب application/xml
  • التعامل مع بيانات الطلب application/json
  • تعامل مع params query uri
  • path طلب الوصول headers
• ردود HTTP
  • HTML أو JSON أو XML أو استجابات النص
  • HTTP إعادة التوجيه
• HTTP التوجيه
  • طرق مع وسيطات العلامة النائمة: /abc/{some}
  • التعامل مع طرق HTTP صالحة متعددة
  • التعامل مع أي طريقة HTTP صالحة
  • التعامل مع الطرق غير المطابقة (404s)
  • دعم رد الاتصال أو نمط الفئة/الطريقة
  • وسيطات اختيارية غير حساسة للطلب على رد الاتصال أو معالجات الفئة/الطريقة
  • دعم التعبيرات العادية: /abc/regex(id=^[0-9]+$)
  • وسيطات الطريق الاختيارية: /abc/{some?}
  • طرق العودة
  • ذاكرة التخزين المؤقت للمسار
• الأوساط
  • فحص أو تصفية طلبات صالحة قبل التوجيه
  • فحص أو تصفية طلبات صالحة بعد التوجيه

انظر Leap Micro-Framework على أساس Ruta.

متطلبات

PHP 8.0 أو الأحدث.

ثَبَّتَ

تثبيت عبر الملحن

composer require joseluisq/ruta:dev-master

الاستخدام

 <?php

declare (strict_types= 1 );

require ' vendor/autoload.php ' ;

use Ruta  Header ;
use Ruta  Method ;
use Ruta  Ruta ;
use Ruta  Request ;
use Ruta  Response ;
use Ruta  Status ;

// 1. Callback style

// NOTE: `Request`, `Response`, `array` (slug arguments) are passed to the callback.
// However they are optional and their order can be modified. See more examples below.

Ruta:: get ( ' /home/hola ' , function ( Request $ req , Response $ res ) {
    $ res -> json ([
        ' host ' => $ req -> header (Header::Host),
        ' headers ' => $ req -> headers (),
    ]);
});
Ruta:: get ( ' /home/hola/redirect ' , function ( Response $ res ) {
    $ res -> redirect ( ' /home/aaa/some/bbb ' );
});
Ruta:: get ( ' /reg/regex(id=^[0-9]+$)/exp ' , function ( Response $ res , array $ args ) {
    $ res -> json ([ ' args ' => $ args ]);
});
Ruta:: post ( ' /home/{path3}/some2 ' , function ( Response $ res ) {
    $ res -> json ([ ' post_data ' => 11010101010 ]);
});

Ruta:: some ( ' /home/some ' , [Method:: POST , Method:: PUT ], function ( Request $ req , Response $ res ) {
    $ res -> json ([ ' only ' => $ req -> method ()]);
});

Ruta:: any ( ' /home/methods ' , function ( Request $ req , Response $ res ) {
    $ res -> json ([ ' method ' => $ req -> method ()]);
});

Ruta:: post ( ' /home/{path} ' , function ( Response $ res ) {
    $ res
        -> header ( ' X-Header-One ' , ' Header Value 1 ' )
        -> header ( ' X-Header-Two ' , ' Header Value 2 ' )
        -> json ([ ' some_data ' => 223424234 ]);
});

// 2. class/method style
class HomeCtrl
{
    public function index ( Request $ req , Response $ res , array $ args )
    {
        // 2.1 $args contains route placeholder values
        if ( array_key_exists ( ' path1 ' , $ args )) {
            // do something...
        }

        // 2.2. Get data provided via `multipart/form-data` 
        $ data = $ req -> multipart ();
        // 2.3. Get all headers
        $ data = $ req -> headers ();
        // 2.4. Get a single header
        $ data = $ req -> header ( " Host " );
        // 2.5. Get data provided via `application/x-www-form-urlencoded` 
        $ data = $ req -> urlencoded ();
        // 2.6. Get data provided via `application/json`
        $ data = $ req -> json ();
        // 2.7. Get data provided via `application/xml`
        $ data = $ req -> xml ();
        // 2.8. Get query data
        $ data = $ req -> query ();

        $ res -> json ([ ' data ' => ' Message from a class! ' ]);
    }

    // Custom 404 reply
    public function not_found ( Response $ res )
    {
        $ res
            -> status (Status::NotFound)
            -> text ( " 404 - Page Not Found! " );
    }
}

Ruta:: get ( ' /home/{path1}/some/{path2} ' , [HomeCtrl::class, ' index ' ]);

// 3. Handle 404 not found routes
Ruta:: not_found ([HomeCtrl::class, ' not_found ' ]);

مثال رمز

ملف: مثال/nginx/public/index.php

 # Or run example using Docker + Nginx server
make compose-up

 # Run example using the PHP built-in server
make container-dev

انتقل الآن على سبيل المثال إلى http: // localhost: 8088/home/hola

مساهمات

لا تتردد في إرسال طلب سحب أو تقديم بعض المشكلات.

مساهمات

ما لم تقل صراحةً خلاف ذلك ، فإن أي مساهمة تم تقديمها عن عمد لإدراجها في العمل الحالي بواسطتك ، كما هو محدد في ترخيص Apache-2.0 ، تكون مرخصة مزدوجة كما هو موضح أدناه ، دون أي شروط أو شروط إضافية.

لا تتردد في إرسال بعض طلب السحب أو المشكلة.

رخصة

يتم توزيع هذا العمل في المقام الأول بموجب شروط كل من ترخيص MIT وترخيص Apache (الإصدار 2.0).

© 2021-خوسيه Quintana الدني