1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<?php
/**
* Copyright 2017 Facebook, Inc.
*
* You are hereby granted a non-exclusive, worldwide, royalty-free license to
* use, copy, modify, and distribute this software in source code or binary
* form for use in connection with the web services and APIs provided by
* Facebook.
*
* As with any software that integrates with the Facebook platform, your use
* of this software is subject to the Facebook Developer Principles and
* Policies [http://developers.facebook.com/policy/]. This copyright notice
* shall be included in all copies or substantial portions of the software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
namespace Facebook;
use ArrayIterator;
use IteratorAggregate;
use ArrayAccess;
/**
* Class FacebookBatchResponse
*
* @package Facebook
*/
class FacebookBatchResponse extends FacebookResponse implements IteratorAggregate, ArrayAccess
{
/**
* @var FacebookBatchRequest The original entity that made the batch request.
*/
protected $batchRequest;
/**
* @var array An array of FacebookResponse entities.
*/
protected $responses = [];
/**
* Creates a new Response entity.
*
* @param FacebookBatchRequest $batchRequest
* @param FacebookResponse $response
*/
public function __construct(FacebookBatchRequest $batchRequest, FacebookResponse $response)
{
$this->batchRequest = $batchRequest;
$request = $response->getRequest();
$body = $response->getBody();
$httpStatusCode = $response->getHttpStatusCode();
$headers = $response->getHeaders();
parent::__construct($request, $body, $httpStatusCode, $headers);
$responses = $response->getDecodedBody();
$this->setResponses($responses);
}
/**
* Returns an array of FacebookResponse entities.
*
* @return array
*/
public function getResponses()
{
return $this->responses;
}
/**
* The main batch response will be an array of requests so
* we need to iterate over all the responses.
*
* @param array $responses
*/
public function setResponses(array $responses)
{
$this->responses = [];
foreach ($responses as $key => $graphResponse) {
$this->addResponse($key, $graphResponse);
}
}
/**
* Add a response to the list.
*
* @param int $key
* @param array|null $response
*/
public function addResponse($key, $response)
{
$originalRequestName = isset($this->batchRequest[$key]['name']) ? $this->batchRequest[$key]['name'] : $key;
$originalRequest = isset($this->batchRequest[$key]['request']) ? $this->batchRequest[$key]['request'] : null;
$httpResponseBody = isset($response['body']) ? $response['body'] : null;
$httpResponseCode = isset($response['code']) ? $response['code'] : null;
// @TODO With PHP 5.5 support, this becomes array_column($response['headers'], 'value', 'name')
$httpResponseHeaders = isset($response['headers']) ? $this->normalizeBatchHeaders($response['headers']) : [];
$this->responses[$originalRequestName] = new FacebookResponse(
$originalRequest,
$httpResponseBody,
$httpResponseCode,
$httpResponseHeaders
);
}
/**
* @inheritdoc
*/
public function getIterator()
{
return new ArrayIterator($this->responses);
}
/**
* @inheritdoc
*/
public function offsetSet($offset, $value)
{
$this->addResponse($offset, $value);
}
/**
* @inheritdoc
*/
public function offsetExists($offset)
{
return isset($this->responses[$offset]);
}
/**
* @inheritdoc
*/
public function offsetUnset($offset)
{
unset($this->responses[$offset]);
}
/**
* @inheritdoc
*/
public function offsetGet($offset)
{
return isset($this->responses[$offset]) ? $this->responses[$offset] : null;
}
/**
* Converts the batch header array into a standard format.
* @TODO replace with array_column() when PHP 5.5 is supported.
*
* @param array $batchHeaders
*
* @return array
*/
private function normalizeBatchHeaders(array $batchHeaders)
{
$headers = [];
foreach ($batchHeaders as $header) {
$headers[$header['name']] = $header['value'];
}
return $headers;
}
}
|
