hyper http php

Veraltet

Diese Bibliothek ist nicht in aktiver Entwicklung.

Bitte betrachten Sie stattdessen GuzzleHttp/Guzzle oder eine andere Bibliothek.

Nur Fehlerbehebungen.

Hyper HTTP -Client

Überblick

Hyper ist ein HTTP -Client, der eine einfache, aber leistungsstarke Schnittstelle für HTTP -Anrufe und Abrufen und Manipulation von API -Daten bereitstellt.

Warum Hyper verwenden?

• Extrem einfache Schnittstelle Hyper::get('http://some/url') .
• Unterstützt auch den Objektstil Hyper::make(...)->get('http://some/url') .
• Bietet ein Response , das nützliche Informationen wie HTTP -Statuscode, Körper und Header bietet.
• Jede Response mischt sich in Rexlabs Array-Object, mit dem Sie die API-Antworten leicht befragen können.
• Wirft eine begrenzte Ausnahme von Ausnahmen (mit Zugriff auf die Anfrage und/oder Antwort) aus, wenn etwas schief geht.
• Sie haben Zugriff auf die ursprüngliche Request über $response->getRequest() .
• Unterstützt alle Guzzle -Client -Funktionen einschließlich Streams.
• Ermöglicht Ihnen, Curl-Anfragen zur Reproduktion aus der Befehlszeile abzugeben.
• Problemlos alle Anfragen protokollieren

Verwendung

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

Installation

In Ihrem Projekt zu installieren:

composer require rexlabs/hyper-http

Beispiele

Die erholsamen Methoden geben alle ein Response zurück, das die Interaktion mit Antworten einfach macht.

Beispiel: Verwenden statischer Methoden

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

Beispiel: Arbeiten mit einer JSON -API

Da Antworten Mixin ArrayObject Sie problemlos Werte aus der Antwort abrufen und manipulieren können:

 <?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 ' ));

Beispiel: Globale Header einstellen und in einem Logger übergeben

Verwenden Sie make() , um die Instanziierung zu vereinfachen und das Objekt dann für zukünftige Anforderungen einzurichten:

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

Beispiel: Instanziierung über den Konstruktor

Verwenden Sie den Konstruktor, um die vollständige Kontrolle über die Instanziierung zu erhalten und in einer Guzzle -Instanz zu bestehen:

 <?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 ' );

Beispiel: Dumpeln einer Curl -Anfrage

Sie können problemlos eine Curl-Anfrage zum Ausführen aus der Befehlszeile erstellen, um Ihre letzte Anfrage zu reproduzieren:

 <?php
use Rexlabs  HyperHttp  Hyper ;

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

Ausgabe:

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

Hyper liefert die folgenden Methoden zur Interaktion mit Remote -Endpunkten:

erhalten()

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

Senden Sie eine HTTP -GET -Anfrage und geben Sie die Antwort zurück:

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

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

• $uri ist eine Zeichenfolge oder ein Uri . Wenn die Zeichenfolge nicht absolut ist, wird sie an den Basis -URI angehängt.
• $query ist eine optionale Reihe von Abfrageparametern, die an die URI beigefügt werden.
• $headers ist eine optionale Reihe von Header (indiziert mit dem Header -Namen), das mit allen globalen Headern zusammengeführt wird.
• $options ist eine optionale Reihe von Guzzle -Client -Optionen.

Post()

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

Senden Sie eine HTTP -Postanforderung und geben Sie die Antwort zurück:

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

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

• $uri ist eine Zeichenfolge oder ein Uri . Wenn die Zeichenfolge nicht absolut ist, wird sie an den Basis -URI angehängt.
• $body ist die Nutzlast. Wenn Sie ein Array angeben, wird es als JSON umgewandelt und transportiert.
• $headers ist eine optionale Reihe von Header (indiziert mit dem Header -Namen), das mit allen globalen Headern zusammengeführt wird.
• $options ist eine optionale Reihe von Guzzle -Client -Optionen.

Alternative Methoden:

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

setzen()

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

Senden Sie eine HTTP -Anfrage und geben Sie die Antwort zurück:

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

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

• $uri ist eine Zeichenfolge oder ein Uri . Wenn die Zeichenfolge nicht absolut ist, wird sie an den Basis -URI angehängt.
• $body ist die Nutzlast. Wenn Sie ein Array angeben, wird es als JSON umgewandelt und transportiert.
• $headers ist eine optionale Reihe von Header (indiziert mit dem Header -Namen), das mit allen globalen Headern zusammengeführt wird.
• $options ist eine optionale Reihe von Guzzle -Client -Optionen.

Patch ()

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

Senden Sie eine HTTP -Patch -Anfrage und geben Sie die Antwort zurück:

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

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

• $uri ist eine Zeichenfolge oder ein Uri . Wenn die Zeichenfolge nicht absolut ist, wird sie an den Basis -URI angehängt.
• $body ist die Nutzlast. Wenn Sie ein Array angeben, wird es als JSON umgewandelt und transportiert.
• $headers ist eine optionale Reihe von Header (indiziert mit dem Header -Namen), das mit allen globalen Headern zusammengeführt wird.
• $options ist eine optionale Reihe von Guzzle -Client -Optionen.

löschen()

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

Senden Sie eine HTTP -Anforderung und geben Sie die Antwort zurück:

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

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

• $uri ist eine Zeichenfolge oder ein Uri . Wenn die Zeichenfolge nicht absolut ist, wird sie an den Basis -URI angehängt.
• $body ist die optionale Nutzlast. Wenn Sie ein Array angeben, wird es als JSON umgewandelt und transportiert.
• $headers ist eine optionale Reihe von Header (indiziert mit dem Header -Namen), das mit allen globalen Headern zusammengeführt wird.
• $options ist eine optionale Reihe von Guzzle -Client -Optionen.

Anruf()

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

Senden Sie eine generische HTTP -Anforderung, indem Sie die method als erstes Argument angeben.

 // 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 ist das HTTP -Verb. Z.B. GET oder etwas, das nicht Teil des Standards ist.
• $uri ist eine Zeichenfolge oder ein Uri . Wenn die Zeichenfolge nicht absolut ist, wird sie an den Basis -URI angehängt.
• $body ist die optionale Nutzlast. Wenn Sie ein Array angeben, wird es als JSON umgewandelt und transportiert.
• $headers ist eine optionale Reihe von Header (indiziert mit dem Header -Namen), das mit allen globalen Headern zusammengeführt wird.
• $options ist eine optionale Reihe von Guzzle -Client -Optionen.

Anfordern von Methoden

Methoden, die aus dem RexlabsHyperHttpMessageRequest Object verfügbar sind:

Geturi ()

Geben Sie das Uriinterface -Objekt zurück, das die URI/URL für diese Anfrage zusammenfasst.

GetMethod ()

Geben Sie das HTTP -Methodenverb für diese Anfrage zurück.

Getheaders ()

Eine Reihe von Kopfzeilen für diese Request zurückerhalten

getCurl ()

Geben Sie eine Curl-Anforderung (String) zurück, die für das Ausführen aus der Befehlszeile geeignet ist. Nützlich für Debugging -Anfragen.

Antwortmethoden

Methoden, die aus dem RexlabsHyperHttpMessageResponse Antwortobjekt verfügbar sind:

GetRequest ()

Geben Sie das RexlabsHyperHttpMessageRequest -Objekt zurück, das der Response zugeordnet ist

getCurlRequest ()

Geben Sie eine Curl-Anforderung (String) zurück, die für das Ausführen aus der Befehlszeile geeignet ist. Nützlich für Debugging -Anfragen.

getStatusScode ()

Geben Sie den HTTP -Statuscode für diese Response zurück. Z.B. 200

GetReasonPhrase ()

Geben Sie den mit dem Statuscode zugeordneten HTTP -Vernunft -Phrase zurück. Z.B. "OK"

isjson ()

Gibt true zurück, wenn dies eine JSON -Antwort ist.

toArray ()

Konvertiert eine JSON -Antwort in ein Array und gibt das Array zurück.

toobject ()

Konvertiert eine JSON -Antwort in ein ArrayObject

ArrayObject

Jedes Response hat alle Methoden und Funktionen der ArrayObject -Klasse aus dem rexlabsarray-object Paket.

Dies bedeutet basierend auf der folgenden Antwortnutzlast:

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

Sie können die folgenden Funktionen ausführen:

 $ 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" ;
}

Sie können auch anrufen:

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

Konfiguration

Setzen Sie die Standardkonfiguration für alle Clients (Standardeinstellungen nach [])

Hyper:: setDefaultConfig ( $ config );

Setzen Sie die Konfiguration für diesen Client (Werte überschreiben / verschmelzen mit Standard))

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

Standardprotokoll

Legen Sie den Standardprotokoll fest, der von allen Clients verwendet wird, die keine bereitstellen.
Muss LoggerInterface implementieren (Standardeinstellungen zu NullLogger )

Hyper:: setDefaultLogger ( $ logger );

Log curl

Protokollieren Sie die Curl -Zeichenfolge für alle Anforderungen (erfordert einen Logger -Satz).

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

Guzzle -Konfiguration

Stellen Sie die Konfiguration ein, die an den zugrunde liegenden GuzzleClient übergeben wurde

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

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

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

Tests

Tests ausführen:

composer tests

Um den Berichterstattungsbericht auszuführen:

composer coverage

Der Deckungsbericht wird an ./tests/report/index.html ausgegeben

Sich erweitern

Hyper ermöglicht eine Erweiterung für benutzerdefinierte Clients von:

• Speichern Sie separate Instanzen für jede Unterklasse von Hyper für den statischen Gebrauch
  • Die statische Verwendung von MyHyperSubclass gibt die richtige Instanz zurück, die von MyHyperSubclass erstellt wurde
  • Die statische Verwendung von Hyper gibt die richtige Instanz zurück, die von Hyper erstellt wurde
• Überschreiben Sie protected static function makeClient um die Client -Klasse anzupassen (z. B. new Client durch new MyClient ersetzen).
• Überschreiben Sie protected static function makeConfig , um die Standard -Client -Konfiguration anzupassen
• Überschreiben Sie protected static function makeGuzzleConfig um den Standard -Guzzle -Client anzupassen
• Überschreiben Sie protected static function getBaseUri um dem Client eine Standard -Base_uri bereitzustellen

Beitragen

Beiträge sind willkommen. Bitte geben Sie eine Pull-Request ein oder erstellen Sie ein Problem. Ihr eingereichter Code sollte mit PSR-1/PSR-2-Standards formatiert werden.

Um

• Autor: Jodie Dunlop
• Lizenz: MIT
• Copyright (C) 2018 Rex Software Pty Ltd