Your IP : 216.73.216.95
<?php
/**
* Copyright 2014 Klarna AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* File containing the abstract base resource class.
*/
namespace Klarna\Rest;
use GuzzleHttp\Exception\RequestException;
use Klarna\Rest\Transport\Connector;
use Klarna\Rest\Transport\Exception\ConnectorException;
use Klarna\Rest\Transport\ResponseValidator;
/**
* Abstract resource class.
*/
abstract class Resource extends \ArrayObject
{
/**
* Id property field name.
*/
const ID_FIELD = 'id';
/**
* Path to the resource endpoint.
*
* @var string
*/
public static $path;
/**
* HTTP transport connector instance.
*
* @var Connector
*/
protected $connector;
/**
* Url to the resource.
*
* @var string
*/
protected $url;
/**
* Constructs a resource instance.
*
* @param Connector $connector HTTP transport instance.
*/
public function __construct(Connector $connector)
{
$this->connector = $connector;
}
/**
* Gets the resource id.
*
* @return string|null
*/
public function getId()
{
return isset($this[static::ID_FIELD]) ? $this[static::ID_FIELD] : null;
}
/**
* Gets the resource location.
*
* @return string|null
*/
public function getLocation()
{
return $this->url;
}
/**
* Sets the resource location.
*
* @param string $url Url to the resource
*
* @return self
*/
public function setLocation($url)
{
$this->url = $url;
return $this;
}
/**
* Fetches the resource.
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \RuntimeException On an unexpected API response
* @throws \RuntimeException If the response content type is not JSON
* @throws \InvalidArgumentException If the JSON cannot be parsed
* @throws \LogicException When Guzzle cannot populate the response
*
* @return self
*/
public function fetch()
{
$data = $this->get($this->getLocation())
->status('200')
->contentType('application/json')
->getJson();
$this->exchangeArray($data);
return $this;
}
/**
* Sends a HTTP request to the specified url.
*
* @param string $method HTTP method, e.g. 'GET'
* @param string $url Request destination
* @param array $options Request options
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \LogicException When Guzzle cannot populate the response
*
* @return ResponseValidator
*/
protected function request($method, $url, array $options = [])
{
$request = $this->connector->createRequest($url, $method, $options);
return new ResponseValidator($this->connector->send($request));
}
/**
* Sends a HTTP GET request to the specified url.
*
* @param string $url Request destination
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \LogicException When Guzzle cannot populate the response
*
* @return ResponseValidator
*/
protected function get($url)
{
return $this->request('GET', $url);
}
/**
* Sends a HTTP PATCH request to the specified url.
*
* @param string $url Request destination
* @param array $data Data to be JSON encoded
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \LogicException When Guzzle cannot populate the response
*
* @return ResponseValidator
*/
protected function patch($url, array $data)
{
return $this->request('PATCH', $url, ['json' => $data]);
}
/**
* Sends a HTTP POST request to the specified url.
*
* @param string $url Request destination
* @param array $data Data to be JSON encoded
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \LogicException When Guzzle cannot populate the response
*
* @return ResponseValidator
*/
protected function post($url, array $data = null)
{
$options = [];
if ($data !== null) {
$options['json'] = $data;
}
return $this->request('POST', $url, $options);
}
}