Guzzle ir PSR-7¶

Prieiga prie antraščių¶

Naudodami hasHeader() metodą galite patikrinti, ar užklausoje arba atsakyme yra tam tikra antraštė.

use GuzzleHttp\Psr7;

$request = new Psr7\Request('GET', '/', ['X-Foo' => 'bar']);

if ($request->hasHeader('X-Foo')) {
    echo 'It is there';
}

Visas antraštės reikšmes galite gauti kaip eilučių masyvą naudodami getHeader().

$request->getHeader('X-Foo'); // ['bar']

// Retrieving a missing header returns an empty array.
$request->getHeader('X-Bar'); // []

Pranešimo antraštes galite peržiūrėti naudodami getHeaders() metodą.

foreach ($request->getHeaders() as $name => $values) {
    echo $name . ': ' . implode(', ', $values) . "\r\n";
}

Sudėtinės antraštės¶

Kai kuriose antraštėse pateikiama papildoma rakto ir vertės poros informacija. Pavyzdžiui, "Link" antraštėse yra nuoroda ir kelios raktų vertės poros:

<http://foo.com>; rel="thing"; type="image/jpeg"

"Guzzle" suteikia patogią funkciją, kurią galima naudoti šių tipų antraštėms analizuoti:

use GuzzleHttp\Psr7;

$request = new Psr7\Request('GET', '/', [
    'Link' => '<http:/.../front.jpeg>; rel="front"; type="image/jpeg"'
]);

$parsed = Psr7\Header::parse($request->getHeader('Link'));
var_export($parsed);

Bus išvesta:

array (
  0 =>
  array (
    0 => '<http:/.../front.jpeg>',
    'rel' => 'front',
    'type' => 'image/jpeg',
  ),
)

Rezultate yra rakto ir vertės porų hash. Antraštės reikšmės, neturinčios rakto (t. y. nuoroda), indeksuojamos skaitmenimis, o antraštės dalys, sudarančios raktą vertės porą, pridedamos kaip rakto ir vertės pora.

Užklausų metodai¶

Kuriant užklausą reikia nurodyti pageidaujamą HTTP metodą. atlikti. Galite nurodyti bet kurį norimą metodą, įskaitant pasirinktinį metodą kuris gali būti neįtrauktas į RFC 7231 (pvz., "MOVE").

// Create a request using a completely custom HTTP method
$request = new \GuzzleHttp\Psr7\Request('MOVE', 'http://httpbin.org/move');

echo $request->getMethod();
// MOVE

Užklausą galite sukurti ir išsiųsti naudodami kliento metodus, kurie atitinka norimą naudoti HTTP metodą.

GET

$client->get('http://httpbin.org/get', [/** options **/])

POST

$client->post('http://httpbin.org/post', [/** options **/])

HEAD

$client->head('http://httpbin.org/get', [/** options **/])

PUT

$client->put('http://httpbin.org/put', [/** options **/])

DELETE

$client->delete('http://httpbin.org/delete', [/** options **/])

GALIMYBĖS

$client->options('http://httpbin.org/get', [/** options **/])

PATCH

$client->patch('http://httpbin.org/put', [/** options **/])

Pavyzdžiui:

$response = $client->patch('http://httpbin.org/patch', ['body' => 'content']);

Užklausos URI¶

Užklausos URI atvaizduojamas Psr\Http\Message\UriInterface objektu. "Guzzle" pateikia šios sąsajos realizaciją, naudodama GuzzleHttp\Psr7\Uri klasę.

Kurdami užklausą, URI galite pateikti kaip eilutę arba Psr\Http\Message\UriInterface egzempliorių.

$response = $client->request('GET', 'http://httpbin.org/get?q=foo');

Schema¶

Užklausos schema nurodo protokolą, kuris turi būti naudojamas siunčiant užklausą. Naudojant "Guzzle schemą galima nustatyti "http" arba "https".

$request = new Request('GET', 'http://httpbin.org');
echo $request->getUri()->getScheme(); // http
echo $request->getUri(); // http://httpbin.org

Šeimininkas¶

Kompiuteris pasiekiamas naudojant URI, kuris priklauso užklausai, arba naudojant Host antraštę.

$request = new Request('GET', 'http://httpbin.org');
echo $request->getUri()->getHost(); // httpbin.org
echo $request->getHeader('Host'); // httpbin.org

Port¶

Naudojant "http" arba "https" schemas prievado naudoti nereikia.

$request = new Request('GET', 'http://httpbin.org:8080');
echo $request->getUri()->getPort(); // 8080
echo $request->getUri(); // http://httpbin.org:8080

Kelias¶

Užklausos kelias pasiekiamas per URI objektą.

$request = new Request('GET', 'http://httpbin.org/get');
echo $request->getUri()->getPath(); // /get

Kelio turinys bus automatiškai filtruojamas, kad būtų užtikrinta, jog tik kelyje būtų pateikti leistini simboliai. Bet kokie neleistini simboliai kelias bus koduojamas procentais pagal RFC 3986 3.3 skyrių.

Užklausos eilutė¶

Užklausos užklausos eilutę galima pasiekti naudojant getQuery() URI objekto, kuriam priklauso užklausa.

$request = new Request('GET', 'http://httpbin.org/?foo=bar');
echo $request->getUri()->getQuery(); // foo=bar

Užklausos eilutės turinys bus automatiškai filtruojamas siekiant užtikrinti, kad užklausos eilutėje būtų tik leistini simboliai. Bet kokie simboliai, kurie užklausos eilutėje yra neleistini, bus koduojami procentais pagal RFC 3986 3.4 skyrių.

Pradžios eilutė¶

Atsakymo pradžios eilutėje pateikiamas protokolas ir protokolo versija, būsenos kodas ir priežasties frazė.

$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'http://httpbin.org/get');

echo $response->getStatusCode(); // 200
echo $response->getReasonPhrase(); // OK
echo $response->getProtocolVersion(); // 1.1

Body¶

Kaip aprašyta anksčiau, atsakymo kūną galite gauti naudodami getBody() metodą.

$body = $response->getBody();
echo $body;
// Cast to a string: { ... }
$body->seek(0);
// Rewind the body
$body->read(1024);
// Read bytes of the body

Srautų kūrimas¶

Geriausias būdas sukurti srautą - naudoti GuzzleHttp\Psr7\Utils::streamFor metodą. Šis metodas priima eilutes, išteklius, grąžintus iš fopen(), objektą, kuris įgyvendina __toString(), iteratorius, šaukinius ir egzempliorius Psr\Http\Message\StreamInterface.

use GuzzleHttp\Psr7;

$stream = Psr7\Utils::streamFor('string data');
echo $stream;
// string data
echo $stream->read(3);
// str
echo $stream->getContents();
// ing data
var_export($stream->eof());
// true
var_export($stream->tell());
// 11

Srautus galite kurti iš iteratorių. Iteratorius gali duoti bet kokį skaičių baitų per vieną iteraciją. Bet kokie pertekliniai iteratoriaus grąžinti baitai, kurie nebuvo srauto vartotojas neprašė, bus įrašyti į buferį iki kito skaitymo.

use GuzzleHttp\Psr7;

$generator = function ($bytes) {
    for ($i = 0; $i < $bytes; $i++) {
        yield '.';
    }
};

$iter = $generator(1024);
$stream = Psr7\Utils::streamFor($iter);
echo $stream->read(3); // ...

Metaduomenys¶

Srautai pateikia srauto metaduomenis per getMetadata() metodą. Šis metodas pateikia duomenis, kuriuos gautumėte iškvietę PHP stream_get_meta_data() funkciją, taip pat gali būti pateikiami kiti pasirinktiniai duomenys.

use GuzzleHttp\Psr7;

$resource = Psr7\Utils::tryFopen('/path/to/file', 'r');
$stream = Psr7\Utils::streamFor($resource);
echo $stream->getMetadata('uri');
// /path/to/file
var_export($stream->isReadable());
// true
var_export($stream->isWritable());
// false
var_export($stream->isSeekable());
// true

Stream Decorators¶

Naudojant srautų dekoratorius labai paprasta srautus papildyti pasirinktinėmis funkcijomis. "Guzzle" pateikia keletą integruotų dekoratorių, kurie suteikia papildomų srauto funkcijų.

• AppendStream
• BufferStream
• CachingStream
• DroppingStream
• FnStream
• InflateStream
• LazyOpenStream
• LimitStream
• MultipartStream
• NoSeekStream
• PumpStream