Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mcoil.corals.io/vendor/shippo/shippo-php/lib/Shippo/ |
<?php
abstract class Shippo_ApiResource extends Shippo_Object
{
protected static function _scopedRetrieve($class, $id, $apiKey = null)
{
$instance = new $class($id, $apiKey);
$instance->refresh();
return $instance;
}
/**
* @returns Shippo_ApiResource The refreshed resource.
*/
public function refresh()
{
$requestor = new Shippo_ApiRequestor($this->_apiKey);
$url = $this->instanceUrl();
list($response, $apiKey) = $requestor->request('get', $url, $this->_retrieveOptions);
$this->refreshFrom($response, $apiKey);
return $this;
}
/**
* @param string $class
*
* @returns string The name of the class, with namespacing and underscores
* stripped.
*/
public static function className($class)
{
// Useful for namespaces: Foo\Shippo_Shipment
if ($postfixNamespaces = strrchr($class, '\\')) {
$class = substr($postfixNamespaces, 1);
}
// Useful for underscored 'namespaces': Foo_Shippo_Shipment
if ($postfixFakeNamespaces = strrchr($class, 'Shippo_')) {
$class = $postfixFakeNamespaces;
}
if (substr($class, 0, strlen('Shippo')) == 'Shippo') {
$class = substr($class, strlen('Shippo'));
}
$class = str_replace('_', '', $class);
$name = urlencode($class);
$name = strtolower($name);
return $name;
}
/**
* @param string $class
*
* @returns string The endpoint URL for the given class.
*/
public static function classUrl($class)
{
$base = self::_scopedLsb($class, 'className', $class);
return "/${base}s";
}
/**
* @returns string The full API URL for this API resource.
*/
public function instanceUrl()
{
$id = $this['id'];
$class = get_class($this);
if ($id === null) {
$message = "Could not determine which URL to request: " . "$class instance has invalid ID: $id";
throw new Shippo_InvalidRequestError($message, null);
}
$id = Shippo_Util::utf8($id);
$base = $this->_lsb('classUrl', $class);
$extn = urlencode($id);
return "$base/$extn";
}
private static function _validateCall($method, $params = null, $apiKey = null)
{
if ($params && !is_array($params)) {
$message = "You must pass an array as the first argument to Shippo API ";
throw new Shippo_Error($message);
}
if ($apiKey && !is_string($apiKey)) {
$message = 'The second argument to Shippo API method calls is an ' . 'optional per-request apiKey (credentials base_64 encoded), which must be a string';
throw new Shippo_Error($message);
}
}
protected static function _scopedAll($class, $params = null, $apiKey = null)
{
self::_validateCall('all', $params, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
list($response, $apiKey) = $requestor->request('get', $url, $params);
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
protected static function _scopedCreate($class, $params = null, $apiKey = null)
{
self::_validateCall('create', $params, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class);
// Correction for malformed shippo URLs
$url = $url . "/";
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
protected static function _scopedUpdate($class, $id, $params = null, $apiKey = null)
{
self::_validateCall('update', $params, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class) . "/" . $id;
list($response, $apiKey) = $requestor->request('put', $url, $params);
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
// Special Case for Rates which has parameters of the format: /url/parameter/url
protected static function _scopedGet($class, $id, $params = null, $apiKey = null)
{
self::_validateCall('create', $params, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = "//shipments/" . $id . "/rates/{$params['currency']}";
list($response, $apiKey) = $requestor->request('get', $url, $params);
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
// Special case for Address Validation
protected static function _scopedValidate($class, $id, $params = null, $apiKey = null)
{
self::_validateCall('create', $params, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class) . "/" . $id . "/validate/";
list($response, $apiKey) = $requestor->request('get', $url, $params);
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
//Special case for Tracking Status
protected static function _scopedGetStatus($class, $id, $params = null, $apiKey = null)
{
self::_validateCall('create', $params, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class) . "/{$params['carrier']}/" . $id;
list($response, $apiKey) = $requestor->request('get', $url, array());
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
protected static function _scopedAddBatch($class, $id, $params = null, $apiKey = null)
{
self::_validateCall('add', $params, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class) . "/" . $id ."/" . 'add_shipments/';
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
protected static function _scopedRemoveBatch($class, $id, $params = null, $apiKey = null)
{
self::_validateCall('add', $params, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class) . "/" . $id ."/" . 'remove_shipments/';
list($response, $apiKey) = $requestor->request('post', $url, $params);
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
protected static function _scopedPurchaseBatch($class, $id, $apiKey = null)
{
self::_validateCall('purchase', null, $apiKey);
$requestor = new Shippo_ApiRequestor($apiKey);
$url = self::_scopedLsb($class, 'classUrl', $class) . "/" . $id ."/" . 'purchase/';
list($response, $apiKey) = $requestor->request('post', $url, null);
return Shippo_Util::convertToShippoObject($response, $apiKey);
}
}