Guzzle и PSR-7¶

Достъп до заглавията¶

Можете да проверите дали дадена заявка или отговор има определен хедър, като използвате метода hasHeader().

use GuzzleHttp\Psr7;

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

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

Можете да извлечете всички стойности на заглавието като масив от низове, като използвате getHeader().

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

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

Можете да прегледате заглавията на дадено съобщение, като използвате метода getHeaders().

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

Сложни заглавия¶

Някои заглавия съдържат допълнителна информация за двойка ключове и стойности. Например заглавията Link съдържат връзка и няколко двойки ключове и стойности:

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

Guzzle предоставя удобна функция, която може да се използва за анализ на тези типове заглавия:

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

Ще произвежда:

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

Резултатът съдържа хеш от двойки ключове и стойности. Стойности на заглавието, които нямат ключ (т.е. връзката), се индексират цифрово, докато частите на заглавията, които образуват ключ стойност, се добавят като двойка ключ-стойност.

Методи за заявка¶

Когато създавате заявка, от вас се очаква да посочите желания HTTP метод. да бъде изпълнен. Можете да посочите всеки метод, който желаете, включително потребителски метод който може да не е част от RFC 7231 (например "MOVE").

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

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

Можете да създадете и изпратите заявка, като използвате методи на клиента, които съответстват на HTTP метода, който искате да използвате.

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 **/])

ВАРИАНТИ

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

PATCH

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

Например:

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

URI на заявката¶

URI на заявката се представя от обект Psr\Http\Message\UriInterface. Guzzle предоставя имплементация на този интерфейс, използвайки GuzzleHttp\Psr7\Uri клас.

Когато създавате заявка, можете да предоставите URI като низ или като инстанция на Psr\Http\Message\UriInterface.

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

Схема¶

схемата на заявката указва протокола, който да се използва при изпращането на заявката. Когато използвате Guzzle, схемата може да бъде зададена като "http" или "https".

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

Домакин¶

Хостът е достъпен чрез URI, принадлежащ на заявката, или чрез достъп до заглавието Host.

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

Port¶

При използване на схемите "http" или "https" не е необходим порт.

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

Path¶

Пътят на заявката е достъпен чрез обекта URI.

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

Съдържанието на пътя ще бъде автоматично филтрирано, за да се гарантира, че само разрешени символи в пътя. Всички неразрешени символи в пътя, ще бъдат кодирани в проценти съгласно RFC 3986, раздел 3.3.

Запитващ низ¶

До низът на заявката може да се получи достъп с помощта на getQuery() на URI обекта, притежаван от заявката.

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

Съдържанието на низ от заявки ще бъде автоматично филтрирано, за да се гарантира, че в низът на заявката да присъстват само разрешени символи. Всички символи, които не са разрешени в низа на заявката, ще бъдат процентно кодирани според RFC 3986, раздел 3.4.

Начална линия¶

Началният ред на отговора съдържа протокола и версията на протокола, кода на състоянието и фразата за причината.

$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¶

Както беше описано по-рано, можете да получите тялото на отговора, като използвате метода getBody().

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

Създаване на потоци¶

Най-добрият начин за създаване на поток е да използвате GuzzleHttp\Psr7\Utils::streamFor метод. Този метод приема низове, ресурси, върнати от fopen(), обект, който имплементира __toString(), итератори, callables и екземпляри на 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

Можете да създавате потоци от итератори. Итераторът може да дава произволен брой байта на итерация. Всички излишни байтове, върнати от итератора, които не са поискани от потребител на поток, ще бъдат буферирани до следващо четене.

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); // ...

Метаданни¶

Потоците разкриват метаданни за потока чрез метода getMetadata(). Този предоставя данните, които бихте извлекли при извикване на PHP функцията stream_get_meta_data(), и по желание може да разкрива други потребителски данни.

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

Декоратори на потоци¶

Добавянето на персонализирана функционалност към потоците е много лесно с помощта на декораторите на потоци. Guzzle предоставя няколко вградени декоратора, които осигуряват допълнителни потоци функционалност.

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