hyper http php

ซึ่งเลิกใช้แล้ว

ห้องสมุดนี้ไม่ได้อยู่ในการพัฒนาที่ใช้งานอยู่

โปรดพิจารณา guzzlehttp/guzzle หรือห้องสมุดอื่นแทน

แก้ไขข้อบกพร่องเท่านั้น

ไคลเอนต์ Hyper HTTP

ภาพรวม

Hyper เป็นไคลเอนต์ HTTP ที่มีจุดมุ่งหมายเพื่อให้อินเทอร์เฟซที่เรียบง่าย แต่ทรงพลังสำหรับการโทร HTTP และการดึงข้อมูลและจัดการข้อมูล API

ทำไมต้องใช้ไฮเปอร์

• อินเทอร์เฟซที่ง่ายมาก Hyper::get('http://some/url')
• นอกจากนี้ยังรองรับ Object Style 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

ตัวอย่าง: การทำงานกับ JSON API

เนื่องจากการตอบสนอง Mixin 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 ' ));

ตัวอย่าง: ตั้งส่วนหัวทั่วโลกและส่งผ่านใน logger

ใช้ 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 ' );

ตัวอย่าง: การทิ้งคำขอ Curl

คุณสามารถสร้างคำขอ CURL สำหรับการรันจากบรรทัดคำสั่งเพื่อทำซ้ำคำขอล่าสุดของคุณ:

 <?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

ส่งคำขอ GET 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 และส่งคืนคำตอบ:

 $ 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 และส่งคืนการตอบกลับ:

 $ 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 Object:

geturi ()

ส่งคืนวัตถุ Uriinterface ซึ่งห่อหุ้ม URI/URL สำหรับคำขอนี้

getMethod ()

ส่งคืนคำกริยาวิธี HTTP สำหรับคำขอนี้

Getheaders ()

retur อาร์เรย์ของส่วนหัวสำหรับ Request นี้

getCurl ()

ส่งคืนคำขอ CURL (สตริง) ที่เหมาะสมสำหรับการรันจากบรรทัดคำสั่ง มีประโยชน์สำหรับการดีบักคำขอ

วิธีการตอบสนอง

วิธีการใช้งานจาก RexlabsHyperHttpMessageResponse Object:

getRequest ()

ส่งคืน RexlabsHyperHttpMessageRequest Object ที่เชื่อมโยงกับ 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 );

ล็อกลอน

บันทึกสตริง Curl สำหรับคำขอทั้งหมด (ต้องใช้ชุดตัวบันทึก)

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

Guzzle Config

ตั้งค่าการกำหนดค่าที่ส่งผ่านไปยัง 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 อนุญาตให้ขยายสำหรับลูกค้าที่กำหนดเองโดย:

• จัดเก็บอินสแตนซ์แยกต่างหากสำหรับแต่ละคลาสย่อยของไฮเปอร์สำหรับการใช้งานแบบคงที่
  • การใช้ MyHyperSubclass แบบคงที่จะส่งคืนอินสแตนซ์ที่ถูกต้องที่สร้างโดย MyHyperSubclass
  • การใช้งานแบบคงที่ของ Hyper จะส่งคืนอินสแตนซ์ที่ถูกต้องที่สร้างขึ้นโดย Hyper
• แทนที่ protected static function makeClient เพื่อปรับแต่งคลาสไคลเอนต์ (เช่นแทนที่ไคล new Client ด้วย new MyClient )
• แทนที่ protected static function makeConfig เพื่อปรับแต่งการกำหนดค่าไคลเอนต์เริ่มต้น
• แทนที่ protected static function makeGuzzleConfig เพื่อปรับแต่งไคลเอนต์ Guzzle เริ่มต้น
• แทนที่ protected static function getBaseUri เพื่อให้ base_uri เริ่มต้นกับไคลเอนต์

การบริจาค

ยินดีต้อนรับการมีส่วนร่วมโปรดส่งคำตอบแบบดึงหรือสร้างปัญหา รหัสที่ส่งของคุณควรจัดรูปแบบโดยใช้มาตรฐาน PSR-1/PSR-2

เกี่ยวกับ

• ผู้แต่ง: Jodie Dunlop
• ใบอนุญาต: MIT
• ลิขสิทธิ์ (c) 2018 REX Software Pty Ltd