Response::getGraphVersion() - Code Metrics - Inspection of "Removed "Facebook" prefix form all classes" - facebook/php-graph-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#888)

by Tobias

created 2017-12-05 07:23 UTC

Response::getGraphVersion() A

↳ Parent: Response

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	1
nc	2
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?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 Facebook\GraphNode\GraphNodeFactory;
use Facebook\Exception\ResponseException;
use Facebook\Exception\SDKException;

/**
 * @package Facebook
 */
class Response
{
    /**
     * @var int the HTTP status code response from Graph
     */
    protected $httpStatusCode;

    /**
     * @var array the headers returned from Graph
     */
    protected $headers;

    /**
     * @var string the raw body of the response from Graph
     */
    protected $body;

    /**
     * @var array the decoded body of the Graph response
     */
    protected $decodedBody = [];

    /**
     * @var Request the original request that returned this response
     */
    protected $request;

    /**
     * @var SDKException the exception thrown by this request
     */
    protected $thrownException;

    /**
     * Creates a new Response entity.
     *
     * @param Request     $request
     * @param null|string $body
     * @param null|int    $httpStatusCode
     * @param null|array  $headers
     */
    public function __construct(Request $request, $body = null, $httpStatusCode = null, array $headers = [])
    {
        $this->request = $request;
        $this->body = $body;
        $this->httpStatusCode = $httpStatusCode;
        $this->headers = $headers;

        $this->decodeBody();
    }

    /**
     * Return the original request that returned this response.
     *
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Return the Application entity used for this response.
     *
     * @return Application
     */
    public function getApplication()
    {
        return $this->request->getApplication();
    }

    /**
     * Return the access token that was used for this response.
     *
     * @return null|string
     */
    public function getAccessToken()
    {
        return $this->request->getAccessToken();
    }

    /**
     * Return the HTTP status code for this response.
     *
     * @return int
     */
    public function getHttpStatusCode()
    {
        return $this->httpStatusCode;
    }

    /**
     * Return the HTTP headers for this response.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Return the raw body response.
     *
     * @return string
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * Return the decoded body response.
     *
     * @return array
     */
    public function getDecodedBody()
    {
        return $this->decodedBody;
    }

    /**
     * Get the app secret proof that was used for this response.
     *
     * @return null|string
     */
    public function getAppSecretProof()
    {
        return $this->request->getAppSecretProof();
    }

    /**
     * Get the ETag associated with the response.
     *
     * @return null|string
     */
    public function getETag()
    {
        return isset($this->headers['ETag']) ? $this->headers['ETag'] : null;
    }

    /**
     * Get the version of Graph that returned this response.
     *
     * @return null|string
     */
    public function getGraphVersion()
    {
        return isset($this->headers['Facebook-API-Version']) ? $this->headers['Facebook-API-Version'] : null;
    }

    /**
     * Returns true if Graph returned an error message.
     *
     * @return bool
     */
    public function isError()
    {
        return isset($this->decodedBody['error']);
    }

    /**
     * Throws the exception.
     *
     * @throws SDKException
     */
    public function throwException()
    {
        throw $this->thrownException;
    }

    /**
     * Instantiates an exception to be thrown later.
     */
    public function makeException()
    {
        $this->thrownException = ResponseException::create($this);
    }

    /**
     * Returns the exception that was thrown for this request.
     *
     * @return null|ResponseException
     */
    public function getThrownException()
    {
        return $this->thrownException;
    }

    /**
     * Convert the raw response into an array if possible.
     *
     * Graph will return 2 types of responses:
     * - JSON(P)
     *    Most responses from Graph are JSON(P)
     * - application/x-www-form-urlencoded key/value pairs
     *    Happens on the `/oauth/access_token` endpoint when exchanging
     *    a short-lived access token for a long-lived access token
     * - And sometimes nothing :/ but that'd be a bug.
     */
    public function decodeBody()
    {
        $this->decodedBody = json_decode($this->body, true);

        if ($this->decodedBody === null) {
            $this->decodedBody = [];
            parse_str($this->body, $this->decodedBody);
        } elseif (is_bool($this->decodedBody)) {
            // Backwards compatibility for Graph < 2.1.
            // Mimics 2.1 responses.
            // @TODO Remove this after Graph 2.0 is no longer supported
            $this->decodedBody = ['success' => $this->decodedBody];
        } elseif (is_numeric($this->decodedBody)) {
            $this->decodedBody = ['id' => $this->decodedBody];
        }

        if (!is_array($this->decodedBody)) {
            $this->decodedBody = [];
        }

        if ($this->isError()) {
            $this->makeException();
        }
    }

    /**
     * Instantiate a new GraphObject from response.
     *
     * @param null|string $subclassName the GraphNode subclass to cast to
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphObject
     *
     * @deprecated 5.0.0 getGraphObject() has been renamed to getGraphNode()
     *
     * @todo v6: Remove this method
     */
    public function getGraphObject($subclassName = null)
    {
        return $this->getGraphNode($subclassName);
    }

    /**
     * Instantiate a new GraphNode from response.
     *
     * @param null|string $subclassName the GraphNode subclass to cast to
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphNode
     */
    public function getGraphNode($subclassName = null)
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphNode($subclassName);
    }

    /**
     * Convenience method for creating a GraphAlbum collection.
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphAlbum
     */
    public function getGraphAlbum()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphAlbum();
    }

    /**
     * Convenience method for creating a GraphPage collection.
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphPage
     */
    public function getGraphPage()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphPage();
    }

    /**
     * Convenience method for creating a GraphSessionInfo collection.
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphSessionInfo
     */
    public function getGraphSessionInfo()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphSessionInfo();
    }

    /**
     * Convenience method for creating a GraphUser collection.
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphUser
     */
    public function getGraphUser()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphUser();
    }

    /**
     * Convenience method for creating a GraphEvent collection.
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphEvent
     */
    public function getGraphEvent()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphEvent();
    }

    /**
     * Convenience method for creating a GraphGroup collection.
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphGroup
     */
    public function getGraphGroup()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphGroup();
    }

    /**
     * Instantiate a new GraphList from response.
     *
     * @param null|string $subclassName the GraphNode subclass to cast list items to
     * @param bool        $auto_prefix  toggle to auto-prefix the subclass name
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphList
     *
     * @deprecated 5.0.0 getGraphList() has been renamed to getGraphEdge()
     *
     * @todo v6: Remove this method
     */
    public function getGraphList($subclassName = null, $auto_prefix = true)
    {
        return $this->getGraphEdge($subclassName, $auto_prefix);
    }

    /**
     * Instantiate a new GraphEdge from response.
     *
     * @param null|string $subclassName the GraphNode subclass to cast list items to
     * @param bool        $auto_prefix  toggle to auto-prefix the subclass name
     *
     * @throws SDKException
     *
     * @return \Facebook\GraphNode\GraphEdge
     */
    public function getGraphEdge($subclassName = null, $auto_prefix = true)
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphEdge($subclassName, $auto_prefix);
    }
}


1			<?php
2			/**
3			* Copyright 2017 Facebook, Inc.
4			*
5			* You are hereby granted a non-exclusive, worldwide, royalty-free license to
6			* use, copy, modify, and distribute this software in source code or binary
7			* form for use in connection with the web services and APIs provided by
8			* Facebook.
9			*
10			* As with any software that integrates with the Facebook platform, your use
11			* of this software is subject to the Facebook Developer Principles and
12			* Policies [http://developers.facebook.com/policy/]. This copyright notice
13			* shall be included in all copies or substantial portions of the software.
14			*
15			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18			* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20			* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21			* DEALINGS IN THE SOFTWARE.
22			*/
23			namespace Facebook;
24
25			use Facebook\GraphNode\GraphNodeFactory;
26			use Facebook\Exception\ResponseException;
27			use Facebook\Exception\SDKException;
28
29			/**
30			* @package Facebook
31			*/
32			class Response
33			{
34			/**
35			* @var int the HTTP status code response from Graph
36			*/
37			protected $httpStatusCode;
38
39			/**
40			* @var array the headers returned from Graph
41			*/
42			protected $headers;
43
44			/**
45			* @var string the raw body of the response from Graph
46			*/
47			protected $body;
48
49			/**
50			* @var array the decoded body of the Graph response
51			*/
52			protected $decodedBody = [];
53
54			/**
55			* @var Request the original request that returned this response
56			*/
57			protected $request;
58
59			/**
60			* @var SDKException the exception thrown by this request
61			*/
62			protected $thrownException;
63
64			/**
65			* Creates a new Response entity.
66			*
67			* @param Request $request
68			* @param null\|string $body
69			* @param null\|int $httpStatusCode
70			* @param null\|array $headers
71			*/
72			public function __construct(Request $request, $body = null, $httpStatusCode = null, array $headers = [])
73			{
74			$this->request = $request;
75			$this->body = $body;
76			$this->httpStatusCode = $httpStatusCode;
77			$this->headers = $headers;
78
79			$this->decodeBody();
80			}
81
82			/**
83			* Return the original request that returned this response.
84			*
85			* @return Request
86			*/
87			public function getRequest()
88			{
89			return $this->request;
90			}
91
92			/**
93			* Return the Application entity used for this response.
94			*
95			* @return Application
96			*/
97			public function getApplication()
98			{
99			return $this->request->getApplication();
100			}
101
102			/**
103			* Return the access token that was used for this response.
104			*
105			* @return null\|string
106			*/
107			public function getAccessToken()
108			{
109			return $this->request->getAccessToken();
110			}
111
112			/**
113			* Return the HTTP status code for this response.
114			*
115			* @return int
116			*/
117			public function getHttpStatusCode()
118			{
119			return $this->httpStatusCode;
120			}
121
122			/**
123			* Return the HTTP headers for this response.
124			*
125			* @return array
126			*/
127			public function getHeaders()
128			{
129			return $this->headers;
130			}
131
132			/**
133			* Return the raw body response.
134			*
135			* @return string
136			*/
137			public function getBody()
138			{
139			return $this->body;
140			}
141
142			/**
143			* Return the decoded body response.
144			*
145			* @return array
146			*/
147			public function getDecodedBody()
148			{
149			return $this->decodedBody;
150			}
151
152			/**
153			* Get the app secret proof that was used for this response.
154			*
155			* @return null\|string
156			*/
157			public function getAppSecretProof()
158			{
159			return $this->request->getAppSecretProof();
160			}
161
162			/**
163			* Get the ETag associated with the response.
164			*
165			* @return null\|string
166			*/
167			public function getETag()
168			{
169			return isset($this->headers['ETag']) ? $this->headers['ETag'] : null;
170			}
171
172			/**
173			* Get the version of Graph that returned this response.
174			*
175			* @return null\|string
176			*/
177			public function getGraphVersion()
178			{
179			return isset($this->headers['Facebook-API-Version']) ? $this->headers['Facebook-API-Version'] : null;
180			}
181
182			/**
183			* Returns true if Graph returned an error message.
184			*
185			* @return bool
186			*/
187			public function isError()
188			{
189			return isset($this->decodedBody['error']);
190			}
191
192			/**
193			* Throws the exception.
194			*
195			* @throws SDKException
196			*/
197			public function throwException()
198			{
199			throw $this->thrownException;
200			}
201
202			/**
203			* Instantiates an exception to be thrown later.
204			*/
205			public function makeException()
206			{
207			$this->thrownException = ResponseException::create($this);
208			}
209
210			/**
211			* Returns the exception that was thrown for this request.
212			*
213			* @return null\|ResponseException
214			*/
215			public function getThrownException()
216			{
217			return $this->thrownException;
218			}
219
220			/**
221			* Convert the raw response into an array if possible.
222			*
223			* Graph will return 2 types of responses:
224			* - JSON(P)
225			* Most responses from Graph are JSON(P)
226			* - application/x-www-form-urlencoded key/value pairs
227			* Happens on the `/oauth/access_token` endpoint when exchanging
228			* a short-lived access token for a long-lived access token
229			* - And sometimes nothing :/ but that'd be a bug.
230			*/
231			public function decodeBody()
232			{
233			$this->decodedBody = json_decode($this->body, true);
234
235			if ($this->decodedBody === null) {
236			$this->decodedBody = [];
237			parse_str($this->body, $this->decodedBody);
238			} elseif (is_bool($this->decodedBody)) {
239			// Backwards compatibility for Graph < 2.1.
240			// Mimics 2.1 responses.
241			// @TODO Remove this after Graph 2.0 is no longer supported
242			$this->decodedBody = ['success' => $this->decodedBody];
243			} elseif (is_numeric($this->decodedBody)) {
244			$this->decodedBody = ['id' => $this->decodedBody];
245			}
246
247			if (!is_array($this->decodedBody)) {
248			$this->decodedBody = [];
249			}
250
251			if ($this->isError()) {
252			$this->makeException();
253			}
254			}
255
256			/**
257			* Instantiate a new GraphObject from response.
258			*
259			* @param null\|string $subclassName the GraphNode subclass to cast to
260			*
261			* @throws SDKException
262			*
263			* @return \Facebook\GraphNode\GraphObject
264			*
265			* @deprecated 5.0.0 getGraphObject() has been renamed to getGraphNode()
266			*
267			* @todo v6: Remove this method
268			*/
269			public function getGraphObject($subclassName = null)
270			{
271			return $this->getGraphNode($subclassName);
272			}
273
274			/**
275			* Instantiate a new GraphNode from response.
276			*
277			* @param null\|string $subclassName the GraphNode subclass to cast to
278			*
279			* @throws SDKException
280			*
281			* @return \Facebook\GraphNode\GraphNode
282			*/
283			public function getGraphNode($subclassName = null)
284			{
285			$factory = new GraphNodeFactory($this);
286
287			return $factory->makeGraphNode($subclassName);
288			}
289
290			/**
291			* Convenience method for creating a GraphAlbum collection.
292			*
293			* @throws SDKException
294			*
295			* @return \Facebook\GraphNode\GraphAlbum
296			*/
297			public function getGraphAlbum()
298			{
299			$factory = new GraphNodeFactory($this);
300
301			return $factory->makeGraphAlbum();
302			}
303
304			/**
305			* Convenience method for creating a GraphPage collection.
306			*
307			* @throws SDKException
308			*
309			* @return \Facebook\GraphNode\GraphPage
310			*/
311			public function getGraphPage()
312			{
313			$factory = new GraphNodeFactory($this);
314
315			return $factory->makeGraphPage();
316			}
317
318			/**
319			* Convenience method for creating a GraphSessionInfo collection.
320			*
321			* @throws SDKException
322			*
323			* @return \Facebook\GraphNode\GraphSessionInfo
324			*/
325			public function getGraphSessionInfo()
326			{
327			$factory = new GraphNodeFactory($this);
328
329			return $factory->makeGraphSessionInfo();
330			}
331
332			/**
333			* Convenience method for creating a GraphUser collection.
334			*
335			* @throws SDKException
336			*
337			* @return \Facebook\GraphNode\GraphUser
338			*/
339			public function getGraphUser()
340			{
341			$factory = new GraphNodeFactory($this);
342
343			return $factory->makeGraphUser();
344			}
345
346			/**
347			* Convenience method for creating a GraphEvent collection.
348			*
349			* @throws SDKException
350			*
351			* @return \Facebook\GraphNode\GraphEvent
352			*/
353			public function getGraphEvent()
354			{
355			$factory = new GraphNodeFactory($this);
356
357			return $factory->makeGraphEvent();
358			}
359
360			/**
361			* Convenience method for creating a GraphGroup collection.
362			*
363			* @throws SDKException
364			*
365			* @return \Facebook\GraphNode\GraphGroup
366			*/
367			public function getGraphGroup()
368			{
369			$factory = new GraphNodeFactory($this);
370
371			return $factory->makeGraphGroup();
372			}
373
374			/**
375			* Instantiate a new GraphList from response.
376			*
377			* @param null\|string $subclassName the GraphNode subclass to cast list items to
378			* @param bool $auto_prefix toggle to auto-prefix the subclass name
379			*
380			* @throws SDKException
381			*
382			* @return \Facebook\GraphNode\GraphList
383			*
384			* @deprecated 5.0.0 getGraphList() has been renamed to getGraphEdge()
385			*
386			* @todo v6: Remove this method
387			*/
388			public function getGraphList($subclassName = null, $auto_prefix = true)
389			{
390			return $this->getGraphEdge($subclassName, $auto_prefix);
391			}
392
393			/**
394			* Instantiate a new GraphEdge from response.
395			*
396			* @param null\|string $subclassName the GraphNode subclass to cast list items to
397			* @param bool $auto_prefix toggle to auto-prefix the subclass name
398			*
399			* @throws SDKException
400			*
401			* @return \Facebook\GraphNode\GraphEdge
402			*/
403			public function getGraphEdge($subclassName = null, $auto_prefix = true)
404			{
405			$factory = new GraphNodeFactory($this);
406
407			return $factory->makeGraphEdge($subclassName, $auto_prefix);
408			}
409			}
410

facebook / php-graph-sdk

Pull Request — master (#888)

Response::getGraphVersion() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like