Guzzlehttp-Guzzle 6からの応答の本文を取得するにはどうすればよいですか?


163

私の会社が開発しているAPIのラッパーを記述しようとしています。それは落ち着いていて、Postmanを使用http://subdomain.dev.myapi.com/api/v1/auth/して、ユーザー名とパスワードをPOSTデータとして使用するなど、エンドポイントに投稿リクエストを送信でき、トークンが返されます。すべてが期待どおりに動作します。さて、PHPから同じことをしようとすると、GuzzleHttp\Psr7\Responseオブジェクトが返されますが、Postmanリクエストで行ったように、その中にトークンを見つけることができません。

関連するコードは次のようになります。

$client = new Client(['base_uri' => 'http://companysub.dev.myapi.com/']);
$response = $client->post('api/v1/auth/', [
    'form_params' => [
        'username' => $user,
        'password' => $password
    ]
]);

var_dump($response); //or $resonse->getBody(), etc...

上記のコードの出力は次のようになります(警告、テキストの着信ウォール):

object(guzzlehttp\psr7\response)#36 (6) {
  ["reasonphrase":"guzzlehttp\psr7\response":private]=>
  string(2) "ok"
  ["statuscode":"guzzlehttp\psr7\response":private]=>
  int(200)
  ["headers":"guzzlehttp\psr7\response":private]=>
  array(9) {
    ["connection"]=>
    array(1) {
      [0]=>
      string(10) "keep-alive"
    }
    ["server"]=>
    array(1) {
      [0]=>
      string(15) "gunicorn/19.3.0"
    }
    ["date"]=>
    array(1) {
      [0]=>
      string(29) "sat, 30 may 2015 17:22:41 gmt"
    }
    ["transfer-encoding"]=>
    array(1) {
      [0]=>
      string(7) "chunked"
    }
    ["content-type"]=>
    array(1) {
      [0]=>
      string(16) "application/json"
    }
    ["allow"]=>
    array(1) {
      [0]=>
      string(13) "post, options"
    }
    ["x-frame-options"]=>
    array(1) {
      [0]=>
      string(10) "sameorigin"
    }
    ["vary"]=>
    array(1) {
      [0]=>
      string(12) "cookie, host"
    }
    ["via"]=>
    array(1) {
      [0]=>
      string(9) "1.1 vegur"
    }
  }
  ["headerlines":"guzzlehttp\psr7\response":private]=>
  array(9) {
    ["connection"]=>
    array(1) {
      [0]=>
      string(10) "keep-alive"
    }
    ["server"]=>
    array(1) {
      [0]=>
      string(15) "gunicorn/19.3.0"
    }
    ["date"]=>
    array(1) {
      [0]=>
      string(29) "sat, 30 may 2015 17:22:41 gmt"
    }
    ["transfer-encoding"]=>
    array(1) {
      [0]=>
      string(7) "chunked"
    }
    ["content-type"]=>
    array(1) {
      [0]=>
      string(16) "application/json"
    }
    ["allow"]=>
    array(1) {
      [0]=>
      string(13) "post, options"
    }
    ["x-frame-options"]=>
    array(1) {
      [0]=>
      string(10) "sameorigin"
    }
    ["vary"]=>
    array(1) {
      [0]=>
      string(12) "cookie, host"
    }
    ["via"]=>
    array(1) {
      [0]=>
      string(9) "1.1 vegur"
    }
  }
  ["protocol":"guzzlehttp\psr7\response":private]=>
  string(3) "1.1"
  ["stream":"guzzlehttp\psr7\response":private]=>
  object(guzzlehttp\psr7\stream)#27 (7) {
    ["stream":"guzzlehttp\psr7\stream":private]=>
    resource(40) of type (stream)
    ["size":"guzzlehttp\psr7\stream":private]=>
    null
    ["seekable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["readable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["writable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["uri":"guzzlehttp\psr7\stream":private]=>
    string(10) "php://temp"
    ["custommetadata":"guzzlehttp\psr7\stream":private]=>
    array(0) {
    }
  }
}

Postmanからの出力は次のようなものでした。

{
    "data" : {
        "token" "fasdfasf-asfasdfasdf-sfasfasf"
    }
}

明らかに、Guzzleで応答オブジェクトを操作することについて何か不足しています。Guzzleレスポンスはリクエストに200ステータスコードを示しているため、返されたデータを取得するために何をする必要があるのか​​正確にはわかりません。


33
$response->getBody()->getContents()動作しませんか?
Federkun、

回答:


435

GuzzleはPSR-7を実装しています。つまり、デフォルトでは、PHPの一時ストリームを使用するStreamにメッセージの本文が格納されます。すべてのデータを取得するには、キャスト演算子を使用できます。

$contents = (string) $response->getBody();

あなたもそれを行うことができます

$contents = $response->getBody()->getContents();

2つのアプローチの違いgetContentsは、残りのコンテンツを返すため、rewindまたはでストリームの位置をシークしない限り、2回目の呼び出しでは何も返されませんseek

$stream = $response->getBody();
$contents = $stream->getContents(); // returns all the contents
$contents = $stream->getContents(); // empty string
$stream->rewind(); // Seek to the beginning
$contents = $stream->getContents(); // returns all the contents

代わりに、PHPの文字列キャスト操作を使用して、ストリームの最初から最後まですべてのデータを読み取ります。

$contents = (string) $response->getBody(); // returns all the contents
$contents = (string) $response->getBody(); // returns all the contents

ドキュメント:http : //docs.guzzlephp.org/en/latest/psr7.html#responses


5
getContents関数は、Guzzle 6のドキュメントの(ストリームセクションの)ほんの一部にしかありません。あなたはたくさんの検索から私を救いました。
Maximus

58
ありがとうございました。これがドキュメントでもっと明確でないのは信じられないことです。彼らの公式ドキュメント(docs.guzzlephp.org/en/latest)でさえ、$ res-> getBody()を呼び出すと通常期待する結果が返されるように見えます。
John

24
彼らは本当に公式文書にメモや通知のようなものを入れるべきです。私はこの問題で2日間無駄にした。
cwhsu 2016

+1 Guzzleのドキュメントには、誤って述べられてい"you can pass true to this method [getBody()] to retrieve the body as a string."ます。これは、Guzzle 6を使用している場合は機能しないようですが、文字列へのキャストまたはgetContents()を使用すると機能します。
Magnus W

8
json_decodeを使用することもできます。たとえば、json_decode($response, true);これに応答をラップすると、配列が返されます 。
Sygon 2018

13

JSONを期待している場合、それを取得する最も簡単な方法:

$data = json_decode($response->getBody()); // returns an object

// OR

$data = json_decode($response->getBody(), true); // returns an array

json_decode()ボディが自動的ににキャストされるためstring、を呼び出す必要はありませんgetContents()


1
なぜこの答えはもっと注目されていないのですか??? これがまさに私が必要としていたことです。ありがとう@MaskimIvanov
Eric McWinNEr

それも私にとって最もシンプルで簡単なことでした。ありがとう
Alator
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.