hyper http php Download - hyper http php Source Code Download

تم إهماله

هذه المكتبة ليست في التطوير النشط.

يرجى النظر في guzzlehttp/guzze أو مكتبة أخرى بدلاً من ذلك.

إصلاحات الأخطاء فقط.

عميل Hyper HTTP

ملخص

Hyper هو عميل HTTP يهدف إلى توفير واجهة بسيطة ولكنها قوية لإجراء مكالمات HTTP وجلب بيانات API ومعالجتها.

لماذا تستخدم Hyper

واجهة بسيطة للغاية Hyper::get('http://some/url') .
يدعم أيضًا نمط الكائن Hyper::make(...)->get('http://some/url') .
يوفر كائن Response يوفر معلومات مفيدة مثل رمز حالة HTTP والجسم والرؤوس.
كل Response تمزج في Rexlabs Array-Object والتي تتيح لك استجواب API بسهولة.
يلقي مجموعة محدودة من الاستثناءات (مع الوصول إلى الطلب و/أو الاستجابة) عندما تسوء الأمور.
يمكنك الوصول إلى Request الأصلي عبر $response->getRequest() .
يدعم جميع وظائف عميل Guzzle بما في ذلك التدفقات.
يسمح لك بتفريغ طلبات Curl للاستنساخ من سطر الأوامر.
قم بتسجيل جميع الطلبات بسهولة

الاستخدام

 <?php
use Rexlabs  HyperHttp  Hyper ;

$ response = Hyper:: get ( ' http://openlibrary.org/subjects/love.json ' );

// The first book for 'love' is: Wuthering Heights
echo " The first book for ' { $ response -> name } ' is: { $ response -> works -> first ()-> title }n" ;

echo " Total works: { $ response -> works -> count ()} books n" ;

تثبيت

للتثبيت في مشروعك:

composer require rexlabs/hyper-http

أمثلة

تقوم جميع الطرق المريحة بإرجاع كائن Response يجعل التفاعل مع الاستجابات بسيطًا.

مثال: استخدام طرق ثابتة

 <?php
use Rexlabs  HyperHttp  Hyper ;

$ response = Hyper:: get ( ' https://example.com/url ' );
echo ' Status Code: ' . $ response -> getStatusCode (). "n" ;
echo ( string ) $ response ; // Output the response body

مثال: العمل مع API JSON

نظرًا لأن الاستجابات تخلط بين ArrayObject ، يمكنك بسهولة جلب القيم ومعالجتها من الاستجابة:

 <?php
use Rexlabs  HyperHttp  Hyper ;

// Fetch historical price via CryptoCompare's public API for Ethereum
$ response = Hyper:: get ( ' https://min-api.cryptocompare.com/data/pricehistorical ' , [
    ' fsym ' => ' ETH ' ,
    ' tsyms ' => ' BTC,USD ' ,
    ' ts ' => ' 1452680400 ' ,
]);

// Output prices
printf ( " ETH->USD: %s n" , $ response -> get ( ' ETH.USD ' ));
printf ( " ETH->BTC: %s n" , $ response -> get ( ' ETH.BTC ' ));

مثال: تعيين الرؤوس العالمية وتمريرها في مسجل

استخدم make() لتبسيط مثيله ثم قم بإعداد الكائن للطلبات المستقبلية:

 <?php
use Rexlabs  HyperHttp  Hyper ;
use Rexlabs  Logger  CustomLogger ;

$ hyper = Hyper:: make ()
    -> setBaseUri ( ' http://example.com/api/v1 ' )
    -> setHeader ( ' X-App-Identity ' , ' Some App ' )
    -> setHeader ( ' X-Correlation-Id ' , ' 12345 ' )
    -> setLogger ( new CustomLogger );

$hyper = Hyper::make(array $config = [], GuzzleHttpClient $guzzle, PsrLogLoggerInterface $logger)

مثال: مثيل عبر مُنشئ

للحصول على سيطرة كاملة على مثيله ، استخدم المُنشئ وتمريره في مثيل Guzzle:

 <?php
use Rexlabs  HyperHttp  Client ;
use GuzzleHttp  Client as GuzzleClient ;
use Psr  Log  NullLogger ;

$ hyper = new Client ( new GuzzleClient (), new NullLogger (), [
   ' base_uri ' => ' http://example.com/api/v1 ' ,
   ' headers ' => [
       ' X-App-Identity ' => ' Some App ' ,
   ],
]);
$ response = $ hyper -> get ( ' /messages ' );

مثال: إلقاء طلب حليقة

يمكنك بسهولة إنشاء طلب حليقة للتشغيل من سطر الأوامر لإعادة إنتاج طلبك الأخير:

 <?php
use Rexlabs  HyperHttp  Hyper ;

echo Hyper:: get ( ' https://example.com/api/v1/resources ' )
    -> getCurlRequest ();

الإخراج:

curl 
  ' https://min-api.cryptocompare.com/data/pricehistorical?fsym=ETH&tsyms=BTC%2CUSD&ts=1452680400&extraParams=your_app_name ' 
  -H ' Content-Type: application/json ' -H ' Accept: application/json '

أساليب HTTP

يوفر Hyper الطرق التالية للتفاعل مع نقاط النهاية البعيدة:

يحصل()

get(mixed $uri, array $query = [], array $headers = [], array $options = []): Response

أرسل طلب HTTP ، وأرجع الاستجابة:

 $ response = Hyper:: get ( ' https://example.com ' , [ ' sort ' => ' latest ' ], [ ' X-Greeting ' => ' Hello! ' ]);

$ response = $ hyper -> get ( ' /v1/people ' );

$uri هي سلسلة أو Uri . إذا لم تكن السلسلة مطلقة ، فسيتم إلحاقها بقاعدة URI.
$query هي مجموعة اختيارية من معلمات الاستعلام التي سيتم إلحاقها بـ URI.
$headers هي مجموعة اختيارية من الرؤوس (مفهرسة باسم الرأس) والتي سيتم دمجها مع أي رؤوس عالمية.
$options هي مجموعة اختيارية من خيارات عميل Guzzle.

بريد()

post(mixed $uri, mixed $body = null, array $headers = [], array $options = []): Response

إرسال طلب نشر HTTP ، وإرجاع الاستجابة:

 $ response = Hyper:: post ( ' https://example.com/fruit ' , ' apples ' );

$ response = $ hyper -> post ( ' /v1/people ' , [ ' name ' => ' Bob ' , ' age ' => 25 ]);

$uri هي سلسلة أو Uri . إذا لم تكن السلسلة مطلقة ، فسيتم إلحاقها بقاعدة URI.
$body هو الحمولة. إذا قدمت صفيفًا ، فسيتم تحويله ونقله إلى JSON.
$headers هي مجموعة اختيارية من الرؤوس (مفهرسة باسم الرأس) والتي سيتم دمجها مع أي رؤوس عالمية.
$options هي مجموعة اختيارية من خيارات عميل Guzzle.

طرق بديلة:

$response = $hyper->postForm($uri, $formParams, $headers, $options);
$response = $hyper->postMultipartForm($uri, $formParams, $headers, $options);

يضع()

put(mixed $uri, mixed $body = null, array $headers = [], array $options = []): Response

أرسل طلب HTTP PUT ، وأرجع الاستجابة:

 $ response = Hyper:: put ( ' https://example.com/fruit ' , ' apples ' );

$ response = $ hyper -> put ( ' /v1/people ' , [ ' name ' => ' Bob ' , ' age ' => 25 ]);

$uri هي سلسلة أو Uri . إذا لم تكن السلسلة مطلقة ، فسيتم إلحاقها بقاعدة URI.
$body هو الحمولة. إذا قدمت صفيفًا ، فسيتم تحويله ونقله إلى JSON.
$headers هي مجموعة اختيارية من الرؤوس (مفهرسة باسم الرأس) والتي سيتم دمجها مع أي رؤوس عالمية.
$options هي مجموعة اختيارية من خيارات عميل Guzzle.

رقعة()

patch(mixed $uri, mixed $body = null, array $headers = [], array $options = []): Response

أرسل طلب تصحيح HTTP ، وأرجع الاستجابة:

 $ response = Hyper:: patch ( ' https://example.com/fruit ' , ' apples ' );

$ response = $ hyper -> patch ( ' /v1/people ' , [ ' name ' => ' Bob ' , ' age ' => 25 ]);

$uri هي سلسلة أو Uri . إذا لم تكن السلسلة مطلقة ، فسيتم إلحاقها بقاعدة URI.
$body هو الحمولة. إذا قدمت صفيفًا ، فسيتم تحويله ونقله إلى JSON.
$headers هي مجموعة اختيارية من الرؤوس (مفهرسة باسم الرأس) والتي سيتم دمجها مع أي رؤوس عالمية.
$options هي مجموعة اختيارية من خيارات عميل Guzzle.

يمسح()

delete(mixed $uri, mixed $body = null, array $headers = [], array $options = []): Response

أرسل طلب HTTP DELETE ، وإرجاع الاستجابة:

 $ response = Hyper:: delete ( ' https://example.com/fruit ' , ' apples ' );

$ response = $ hyper -> delete ( ' /v1/people/1 ' );

$uri هي سلسلة أو Uri . إذا لم تكن السلسلة مطلقة ، فسيتم إلحاقها بقاعدة URI.
$body هو الحمولة الاختيارية. إذا قدمت صفيفًا ، فسيتم تحويله ونقله إلى JSON.
$headers هي مجموعة اختيارية من الرؤوس (مفهرسة باسم الرأس) والتي سيتم دمجها مع أي رؤوس عالمية.
$options هي مجموعة اختيارية من خيارات عميل Guzzle.

يتصل()

call(string $method, mixed $uri, mixed $body, array $headers, array $options): Response

إرسال طلب HTTP عام عن طريق تحديد method كوسيطة الأولى.

 // Statically
$ response = Hyper:: call ( ' MOVE ' , ' myfile1234 ' , [ ' new_location ' => ' some_folder ' ]);

// Http method verbs may also be invoked via method name
$ response = Hyper:: move ( ' myfile1234 ' , [ ' new_location ' => ' some_folder ' ]);
$ response = Hyper:: somethingelse (...);

// Via object
$ response = $ hyper -> call ( ' MOVE ' , ' myfile1234 ' , [ ' new_location ' => ' some_folder ' ]);

$method هي الفعل HTTP. على سبيل المثال. GET شيء أو شيء ليس جزءًا من المعيار.
$uri هي سلسلة أو Uri . إذا لم تكن السلسلة مطلقة ، فسيتم إلحاقها بقاعدة URI.
$body هو الحمولة الاختيارية. إذا قدمت صفيفًا ، فسيتم تحويله ونقله إلى JSON.
$headers هي مجموعة اختيارية من الرؤوس (مفهرسة باسم الرأس) والتي سيتم دمجها مع أي رؤوس عالمية.
$options هي مجموعة اختيارية من خيارات عميل Guzzle.

طرق الطلب

الأساليب المتاحة من RexlabsHyperHttpMessageRequest كائن:

geturi ()

إرجاع كائن uriinterface الذي يتضمن URI/URL لهذا الطلب.

getMethod ()

إرجاع الفعل طريقة HTTP لهذا الطلب.

Getheaders ()

استمع إلى مجموعة من الرؤوس لهذا Request

getCurl ()

إرجاع طلب Curl (سلسلة) مناسب للتشغيل من سطر الأوامر. مفيد لطلبات تصحيح الأخطاء.

طرق الاستجابة

الأساليب المتاحة من RexlabsHyperHttpMessageResponse كائن:

getRequest ()

إرجاع RexlabsHyperHttpMessageRequest كائن مرتبط Response

getCurlrequest ()

إرجاع طلب Curl (سلسلة) مناسب للتشغيل من سطر الأوامر. مفيد لطلبات تصحيح الأخطاء.

getStatuscode ()

إرجاع رمز حالة HTTP لهذا Response . على سبيل المثال. 200

getReasonphrase ()

إرجاع عبارة عقل HTTP المرتبطة برمز الحالة. على سبيل المثال. "نعم"

isjson ()

يعود true إذا كان هذا استجابة JSON.

Toarray ()

يحول استجابة JSON إلى صفيف ويعيد الصفيف.

Toobject ()

يحول استجابة JSON إلى ArrayObject

ArrayObject

يحتوي كل كائن Response على جميع طرق ووظائف فئة ArrayObject من حزمة rexlabsarray-object .

هذا يعني بناءً على حمولة الاستجابة التالية:

{
  "books" : [
    {
      "id" : 1 ,
      "title" : " 1984 " ,
      "author" : " George Orwell "
    },
    {
      "id" : 2 ,
      "title" : " Pride and Prejudice " ,
      "author" : " Jane Austen "
    }
  ]
}

يمكنك تنفيذ الوظائف التالية:

 $ response -> books ; // Instance of ArrayObject
$ response -> books -> pluckArray ( ' author ' ); // array [ 'George Orwell', 'Jane Austen' ]
$ response -> pluckArray ( ' books.author ' ); // array [ 'George Orwell', 'Jane Austen' ]
$ response -> books -> count (); // 2
$ response -> books -> isCollection (); // true
$ response -> books [ 0 ]; // Instance of ArrayObject
$ response -> books [ 0 ]-> isCollection (); // false
$ response -> books [ 0 ]-> id ; // 1
$ response -> get ( ' books.1.title ' );    // "Pride and Prejudice"
foreach ( $ response -> books as $ book ) {
    echo "{ $ book -> title } by { $ book -> author }n" ;
}

يمكنك أيضا الاتصال:

 $ obj = $ response -> toObject ();   // Instance of Arraybject

تكوين

اضبط التكوين الافتراضي لجميع العميل (الافتراضيات إلى [])

Hyper:: setDefaultConfig ( $ config );

تعيين التكوين لهذا العميل (سيتم تجاوز / دمج القيم مع الافتراضي)

 $ client = Hyper:: make ( $ config );

المسجل الافتراضي

قم بتعيين المسجل الافتراضي الذي يستخدمه جميع العملاء الذين لا يقدمون واحد.
يجب تنفيذ LoggerInterface (الافتراضية إلى NullLogger )

Hyper:: setDefaultLogger ( $ logger );

سجل حليقة

قم بتسجيل سلسلة حليقة لجميع الطلبات (تتطلب مجموعة مسجل)

 $ config = [
    ' log_curl ' => true ,
];

تكوين Guzzle

اضبط التهيئة التي تم تمريرها على GuzzleClient الأساسي

 $ config = [
    ' guzzle ' => [
        ' verify ' => false ,
    ],
];

// Set for all clients
Hyper:: setDefaultConfig ( $ config );

// Set for one client
$ client = Hyper:: make ( $ config );

الاختبارات

لتشغيل الاختبارات:

composer tests

لتشغيل تقرير التغطية:

composer coverage

تقرير التغطية هو الإخراج إلى ./tests/report/index.html

تمتد

يسمح Hyper بتمديد للعملاء المخصصين بواسطة:

تخزين مثيلات منفصلة لكل فئة فرعية من Hyper للاستخدام الثابت
- سيؤدي الاستخدام الثابت MyHyperSubclass MyHyperSubclass
- سيؤدي الاستخدام الثابت لـ Hyper إلى إرجاع المثيل الصحيح الذي تم إنشاؤه بواسطة Hyper
تجاوز protected static function makeClient لتخصيص فئة العميل (على سبيل المثال ، استبدل new Client بـ new MyClient )
تجاوز protected static function makeConfig لتخصيص تكوين العميل الافتراضي
تجاوز protected static function makeGuzzleConfig لتخصيص عميل Guzz الافتراضي
تجاوز protected static function getBaseUri لتوفير قاعدة افتراضية للعميل

المساهمة

المساهمات موضع ترحيب ، يرجى تقديم طلب سحب أو إنشاء مشكلة. يجب تنسيق الرمز المقدم باستخدام معايير PSR-1/PSR-2.

عن

المؤلف: جودي دنلوب
الترخيص: معهد ماساتشوستس للتكنولوجيا
حقوق الطبع والنشر (C) 2018 Rex Software Pty Ltd

يوسع