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/cartforge.co/vendor/magento/module-usps/Model/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Usps\Model;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Async\CallbackDeferred;
use Magento\Framework\DataObject;
use Magento\Framework\HTTP\AsyncClient\HttpException;
use Magento\Framework\HTTP\AsyncClient\Request;
use Magento\Framework\HTTP\AsyncClientInterface;
use Magento\Framework\HTTP\LaminasClient;
use Magento\Framework\HTTP\LaminasClientFactory;
use Magento\Framework\Measure\Length;
use Magento\Framework\Measure\Weight;
use Magento\Framework\Xml\Security;
use Magento\Quote\Model\Quote\Address\RateRequest;
use Magento\Shipping\Helper\Carrier as CarrierHelper;
use Magento\Shipping\Model\Carrier\AbstractCarrier;
use Magento\Shipping\Model\Carrier\AbstractCarrierOnline;
use Magento\Shipping\Model\Rate\Result;
use Magento\Shipping\Model\Rate\Result\ProxyDeferredFactory;
use Magento\Usps\Helper\Data as DataHelper;
/**
* USPS shipping
* @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* phpcs:disable Magento2.Annotation.MethodAnnotationStructure
*/
class Carrier extends AbstractCarrierOnline implements \Magento\Shipping\Model\Carrier\CarrierInterface
{
/** @deprecated Redundant dependency */
public const CONTAINER_VARIABLE = 'VARIABLE';
/** @deprecated Redundant dependency */
public const CONTAINER_FLAT_RATE_BOX = 'FLAT RATE BOX';
/** @deprecated Redundant dependency */
public const CONTAINER_FLAT_RATE_ENVELOPE = 'FLAT RATE ENVELOPE';
/** @deprecated Redundant dependency */
public const CONTAINER_RECTANGULAR = 'RECTANGULAR';
/** @deprecated Redundant dependency */
public const CONTAINER_NONRECTANGULAR = 'NONRECTANGULAR';
/**
* USPS size
*/
public const SIZE_REGULAR = 'REGULAR';
public const SIZE_LARGE = 'LARGE';
/**
* Default api revision
*
* @var int
*/
public const DEFAULT_REVISION = 2;
/**
* Code of the carrier
*
* @var string
*/
public const CODE = 'usps';
/**
* Ounces in one pound for conversion
*/
public const OUNCES_POUND = 16;
/**
* Code of the carrier
*
* @var string
*/
protected $_code = self::CODE;
/**
* @var int
*/
private static $weightPrecision = 10;
/**
* Rate request data
*
* @var \Magento\Quote\Model\Quote\Address\RateRequest|null
*/
protected $_request = null;
/**
* Rate result data
*
* @var Result|null
*/
protected $_result = null;
/**
* Default cgi gateway url
*
* @var string
*/
protected $_defaultGatewayUrl = 'https://production.shippingapis.com/ShippingAPI.dll';
/**
* Container types that could be customized for USPS carrier
*
* @var string[]
*/
protected $_customizableContainerTypes = ['VARIABLE', 'RECTANGULAR', 'NONRECTANGULAR'];
/**
* The carrier helper
*
* @var \Magento\Shipping\Helper\Carrier
*/
protected $_carrierHelper;
/**
* @var \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory
*/
protected $_productCollectionFactory;
/**
* @var LaminasClientFactory
* @deprecated Use asynchronous client.
* @see $httpClient
*/
protected $_httpClientFactory;
/**
* @var string[]
*/
protected $_debugReplacePrivateDataKeys = [
'USERID'
];
/**
* @var DataHelper
*/
private $dataHelper;
/**
* @var AsyncClientInterface
*/
private $httpClient;
/**
* @var ProxyDeferredFactory
*/
private $proxyDeferredFactory;
/**
* @var DataObject
*/
private $_rawTrackRequest;
/**
* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
* @param \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory
* @param \Psr\Log\LoggerInterface $logger
* @param Security $xmlSecurity
* @param \Magento\Shipping\Model\Simplexml\ElementFactory $xmlElFactory
* @param \Magento\Shipping\Model\Rate\ResultFactory $rateFactory
* @param \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory
* @param \Magento\Shipping\Model\Tracking\ResultFactory $trackFactory
* @param \Magento\Shipping\Model\Tracking\Result\ErrorFactory $trackErrorFactory
* @param \Magento\Shipping\Model\Tracking\Result\StatusFactory $trackStatusFactory
* @param \Magento\Directory\Model\RegionFactory $regionFactory
* @param \Magento\Directory\Model\CountryFactory $countryFactory
* @param \Magento\Directory\Model\CurrencyFactory $currencyFactory
* @param \Magento\Directory\Helper\Data $directoryData
* @param \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry
* @param \Magento\Shipping\Helper\Carrier $carrierHelper
* @param \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory
* @param LaminasClientFactory $httpClientFactory
* @param array $data
* @param AsyncClientInterface|null $httpClient
* @param ProxyDeferredFactory|null $proxyDeferredFactory
* @param DataHelper|null $dataHelper
*
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
\Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory,
\Psr\Log\LoggerInterface $logger,
Security $xmlSecurity,
\Magento\Shipping\Model\Simplexml\ElementFactory $xmlElFactory,
\Magento\Shipping\Model\Rate\ResultFactory $rateFactory,
\Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory,
\Magento\Shipping\Model\Tracking\ResultFactory $trackFactory,
\Magento\Shipping\Model\Tracking\Result\ErrorFactory $trackErrorFactory,
\Magento\Shipping\Model\Tracking\Result\StatusFactory $trackStatusFactory,
\Magento\Directory\Model\RegionFactory $regionFactory,
\Magento\Directory\Model\CountryFactory $countryFactory,
\Magento\Directory\Model\CurrencyFactory $currencyFactory,
\Magento\Directory\Helper\Data $directoryData,
\Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry,
CarrierHelper $carrierHelper,
\Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory,
LaminasClientFactory $httpClientFactory,
array $data = [],
?AsyncClientInterface $httpClient = null,
?ProxyDeferredFactory $proxyDeferredFactory = null,
?DataHelper $dataHelper = null
) {
$this->_carrierHelper = $carrierHelper;
$this->_productCollectionFactory = $productCollectionFactory;
$this->_httpClientFactory = $httpClientFactory;
parent::__construct(
$scopeConfig,
$rateErrorFactory,
$logger,
$xmlSecurity,
$xmlElFactory,
$rateFactory,
$rateMethodFactory,
$trackFactory,
$trackErrorFactory,
$trackStatusFactory,
$regionFactory,
$countryFactory,
$currencyFactory,
$directoryData,
$stockRegistry,
$data
);
$this->httpClient = $httpClient ?? ObjectManager::getInstance()->get(AsyncClientInterface::class);
$this->proxyDeferredFactory = $proxyDeferredFactory
?? ObjectManager::getInstance()->get(ProxyDeferredFactory::class);
$this->dataHelper = $dataHelper ?? ObjectManager::getInstance()->get(DataHelper::class);
}
/**
* Collect and get rates
*
* @param RateRequest $request
* @return \Magento\Quote\Model\Quote\Address\RateResult\Error|bool|Result
*/
public function collectRates(RateRequest $request)
{
if (!$this->canCollectRates()) {
return $this->getErrorMessage();
}
$this->setRequest($request);
//Saving current result to use the right one in the callback.
$this->_result = $result = $this->_getQuotes();
return $this->proxyDeferredFactory->create(
[
'deferred' => new CallbackDeferred(
function () use ($request, $result) {
$this->_result = $result;
$this->_updateFreeMethodQuote($request);
return $this->getResult();
}
)
]
);
}
/**
* Prepare and set request to this instance
*
* @param \Magento\Quote\Model\Quote\Address\RateRequest $request
* @return $this
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
public function setRequest(\Magento\Quote\Model\Quote\Address\RateRequest $request)
{
$this->_request = $request;
$r = new \Magento\Framework\DataObject();
if ($request->getLimitMethod()) {
$r->setService($request->getLimitMethod());
} else {
$r->setService('ALL');
}
if ($request->getUspsUserid()) {
$userId = $request->getUspsUserid();
} else {
$userId = $this->getConfigData('userid');
}
$r->setUserId($userId);
if ($request->getUspsContainer()) {
$container = $request->getUspsContainer();
} else {
$container = $this->getConfigData('container');
}
$r->setContainer($container);
if ($request->getUspsSize()) {
$size = $request->getUspsSize();
} else {
$size = $this->getConfigData('size');
}
$r->setSize($size);
if ($request->getGirth()) {
$girth = $request->getGirth();
} else {
$girth = $this->getConfigData('girth');
}
$r->setGirth($girth);
if ($request->getHeight()) {
$height = $request->getHeight();
} else {
$height = $this->getConfigData('height');
}
$r->setHeight($height);
if ($request->getLength()) {
$length = $request->getLength();
} else {
$length = $this->getConfigData('length');
}
$r->setLength($length);
if ($request->getWidth()) {
$width = $request->getWidth();
} else {
$width = $this->getConfigData('width');
}
$r->setWidth($width);
if ($request->getUspsMachinable()) {
$machinable = $request->getUspsMachinable();
} else {
$machinable = $this->getConfigData('machinable');
}
$r->setMachinable($machinable);
if ($request->getOrigPostcode()) {
$r->setOrigPostal($request->getOrigPostcode());
} else {
$r->setOrigPostal(
$this->_scopeConfig->getValue(
\Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_ZIP,
\Magento\Store\Model\ScopeInterface::SCOPE_STORE,
$request->getStoreId()
)
);
}
if ($request->getOrigCountryId()) {
$r->setOrigCountryId($request->getOrigCountryId());
} else {
$r->setOrigCountryId(
$this->_scopeConfig->getValue(
\Magento\Sales\Model\Order\Shipment::XML_PATH_STORE_COUNTRY_ID,
\Magento\Store\Model\ScopeInterface::SCOPE_STORE,
$request->getStoreId()
)
);
}
if ($request->getDestCountryId()) {
$destCountry = $request->getDestCountryId();
} else {
$destCountry = self::USA_COUNTRY_ID;
}
$r->setDestCountryId($destCountry);
if (!$this->_isUSCountry($destCountry)) {
$r->setDestCountryName($this->_getCountryName($destCountry));
}
if ($request->getDestPostcode()) {
$r->setDestPostal($request->getDestPostcode());
}
if ($request->getFreeMethodWeight() != $request->getPackageWeight()) {
$r->setFreeMethodWeight($request->getFreeMethodWeight());
}
$r->setPackages($this->createPackages((float) $request->getPackageWeight(), (array) $request->getPackages()));
$r->setWeightPounds(floor($request->getPackageWeight()));
$ounces = ($request->getPackageWeight() - floor($request->getPackageWeight())) * self::OUNCES_POUND;
$r->setWeightOunces(sprintf('%.' . self::$weightPrecision . 'f', $ounces));
$r->setValue($request->getPackageValue());
$r->setValueWithDiscount($request->getPackageValueWithDiscount());
$r->setBaseSubtotalInclTax($request->getBaseSubtotalInclTax());
$this->setRawRequest($r);
return $this;
}
/**
* Get final price for shipping method with handling fee per package
*
* @param float $cost
* @param string $handlingType
* @param float $handlingFee
* @return float
*/
protected function _getPerpackagePrice($cost, $handlingType, $handlingFee)
{
if ($handlingType == AbstractCarrier::HANDLING_TYPE_PERCENT) {
return $cost + $cost * $this->_numBoxes * $handlingFee / 100;
}
return $cost + $this->_numBoxes * $handlingFee;
}
/**
* Get final price for shipping method with handling fee per order
*
* @param float $cost
* @param string $handlingType
* @param float $handlingFee
* @return float
*/
protected function _getPerorderPrice($cost, $handlingType, $handlingFee)
{
if ($handlingType == self::HANDLING_TYPE_PERCENT) {
return $cost + $cost * $handlingFee / 100;
}
return $cost + $handlingFee;
}
/**
* Get result of request
*
* @return Result|null
*/
public function getResult()
{
return $this->_result;
}
/**
* @inheritdoc
*
* Starting from 23.02.2018 USPS doesn't allow to create free shipping labels via their API.
*/
public function isShippingLabelsAvailable()
{
return false;
}
/**
* Get quotes
*
* @return Result
*/
protected function _getQuotes()
{
return $this->_getXmlQuotes();
}
/**
* Set free method request
*
* @param string $freeMethod
* @return void
*/
protected function _setFreeMethodRequest($freeMethod)
{
$r = $this->_rawRequest;
$weight = $this->getTotalNumOfBoxes($r->getFreeMethodWeight());
$r->setWeightPounds(floor($weight));
$ounces = ($weight - floor($weight)) * self::OUNCES_POUND;
$r->setWeightOunces(sprintf('%.' . self::$weightPrecision . 'f', $ounces));
$r->setPackages($this->createPackages((float)$r->getFreeMethodWeight(), []));
$r->setService($freeMethod);
}
/**
* Build RateV3 request, send it to USPS gateway and retrieve quotes in XML format
*
* @link http://www.usps.com/webtools/htm/Rate-Calculators-v2-3.htm
* @return Result
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
protected function _getXmlQuotes()
{
$r = $this->_rawRequest;
// The origin address(shipper) must be only in USA
if (!$this->_isUSCountry($r->getOrigCountryId())) {
$responseBody = '';
return $this->_parseXmlResponse($responseBody);
}
if ($this->_isUSCountry($r->getDestCountryId())) {
$xml = $this->_xmlElFactory->create(
['data' => '<?xml version="1.0" encoding="UTF-8"?><RateV4Request/>']
);
$xml->addAttribute('USERID', $r->getUserId());
// according to usps v4 documentation
$xml->addChild('Revision', '2');
foreach ($r->getPackages() as $key => $packageData) {
$package = $xml->addChild('Package');
$package->addAttribute('ID', $key);
$service = $this->getCode('service_to_code', $r->getService());
if (!$service) {
$service = $r->getService();
}
if ($r->getContainer() !== null && (strpos($r->getContainer(), 'FLAT RATE ENVELOPE') !== false ||
strpos($r->getContainer(), 'FLAT RATE BOX') !== false)
) {
$service = 'Priority';
}
$package->addChild('Service', $service);
// no matter Letter, Flat or Parcel, use Parcel
if ($r->getService() == 'FIRST CLASS' || $r->getService() == 'FIRST CLASS HFP COMMERCIAL') {
$package->addChild('FirstClassMailType', 'PARCEL');
}
$package->addChild('ZipOrigination', $r->getOrigPostal());
//only 5 chars available
$package->addChild(
'ZipDestination',
is_string($r->getDestPostal()) ? substr($r->getDestPostal(), 0, 5) : ''
);
$package->addChild('Pounds', $packageData['weight_pounds']);
$package->addChild('Ounces', $packageData['weight_ounces']);
// Because some methods don't accept VARIABLE and (NON)RECTANGULAR containers
$package->addChild('Container', $r->getContainer());
$package->addChild('Size', $r->getSize());
if ($r->getSize() == 'LARGE') {
$package->addChild('Width', $r->getWidth());
$package->addChild('Length', $r->getLength());
$package->addChild('Height', $r->getHeight());
if ($r->getContainer() == 'NONRECTANGULAR' || $r->getContainer() == 'VARIABLE') {
$package->addChild('Girth', $r->getGirth());
}
}
$package->addChild('Machinable', $r->getMachinable());
}
$api = 'RateV4';
} else {
$xml = $this->_xmlElFactory->create(
['data' => '<?xml version = "1.0" encoding = "UTF-8"?><IntlRateV2Request/>']
);
$xml->addAttribute('USERID', $r->getUserId());
// according to usps v4 documentation
$xml->addChild('Revision', '2');
foreach ($r->getPackages() as $key => $packageData) {
$package = $xml->addChild('Package');
$package->addAttribute('ID', $key);
$package->addChild('Pounds', $packageData['weight_pounds']);
$package->addChild('Ounces', $packageData['weight_ounces']);
$package->addChild('MailType', 'All');
$package->addChild('ValueOfContents', $r->getValue());
$package->addChild('Country', $r->getDestCountryName());
$package->addChild('Container', $r->getContainer());
$package->addChild('Size', $r->getSize());
$width = $length = $height = $girth = '';
if ($r->getSize() == 'LARGE') {
$width = $r->getWidth();
$length = $r->getLength();
$height = $r->getHeight();
if ($r->getContainer() == 'NONRECTANGULAR') {
$girth = $r->getGirth();
}
}
$package->addChild('Width', $width);
$package->addChild('Length', $length);
$package->addChild('Height', $height);
$package->addChild('Girth', $girth);
$package->addChild('OriginZip', $r->getOrigPostal());
$package->addChild('AcceptanceDateTime', date('c'));
$package->addChild('DestinationPostalCode', $r->getDestPostal());
}
$api = 'IntlRateV2';
}
$request = $xml->asXML();
$responseBody = $this->_getCachedQuotes($request);
if ($responseBody === null) {
$debugData = ['request' => $this->filterDebugData($request)];
$url = $this->getConfigData('gateway_url');
if (!$url) {
$url = $this->_defaultGatewayUrl;
}
$deferredResponse = $this->httpClient->request(
new Request(
$url . '?API=' . urlencode($api) . '&XML=' . urlencode($request),
Request::METHOD_GET,
[],
null
)
);
return $this->proxyDeferredFactory->create(
[
'deferred' => new CallbackDeferred(
function () use ($deferredResponse, $request, $debugData) {
$responseResult = null;
try {
$responseResult = $deferredResponse->get();
} catch (HttpException $exception) {
$this->_logger->critical($exception);
}
$responseBody = $responseResult ? $responseResult->getBody() : '';
$debugData['result'] = $responseBody;
$this->_setCachedQuotes($request, $responseBody);
$this->_debug($debugData);
return $this->_parseXmlResponse($responseBody);
}
)
]
);
}
return $this->_parseXmlResponse($responseBody);
}
/**
* Parse calculated rates
*
* @param string $response
* @return Result
* @link http://www.usps.com/webtools/htm/Rate-Calculators-v2-3.htm
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
* phpcs:disable Generic.Metrics.NestingLevel.TooHigh
*/
protected function _parseXmlResponse($response)
{
$r = $this->_rawRequest;
$allowedMethods = explode(',', $this->getConfigData('allowed_methods') ?? '');
$serviceCodeToActualNameMap = [];
$isUS = $this->_isUSCountry($r->getDestCountryId());
$costArr = [];
if (strlen(trim($response)) > 0 && strpos(trim($response), '<?xml') === 0) {
if (strpos($response, '<?xml version="1.0"?>') !== false) {
$response = str_replace(
'<?xml version="1.0"?>',
'<?xml version="1.0" encoding="ISO-8859-1"?>',
$response
);
}
$xml = $this->parseXml($response);
if (is_object($xml) && is_object($xml->Package)) {
foreach ($xml->Package as $package) {
if ($isUS && is_object($package->Postage)) {
/**
* US Rates
*/
foreach ($package->Postage as $postage) {
$serviceName = $this->_filterServiceName((string)$postage->MailService);
$serviceCode = $this->getCode('method_to_code', $serviceName)
?: (string) $postage->attributes()->CLASSID;
$serviceCodeToActualNameMap[$serviceCode] = $serviceName;
if (in_array($serviceCode, $allowedMethods)) {
$costArr[$serviceCode] = isset($costArr[$serviceCode])
? $costArr[$serviceCode] + (float) $postage->Rate
: (float) $postage->Rate;
}
}
} elseif (!$isUS && is_object($package->Service)) {
/*
* International Rates
*/
foreach ($package->Service as $service) {
$serviceName = $this->_filterServiceName((string)$service->SvcDescription);
$serviceCode = 'INT_' . $service->attributes()->ID;
$serviceCodeToActualNameMap[$serviceCode] = $serviceName;
if ($this->isServiceAvailable($service) && in_array($serviceCode, $allowedMethods)) {
$costArr[$serviceCode] = isset($costArr[$serviceCode])
? $costArr[$serviceCode] + (float) $service->Postage
: (float) $service->Postage;
}
}
}
}
}
}
uasort($costArr, function ($previous, $next) {
return ($previous <= $next) ? -1 : 1;
});
$result = $this->_rateFactory->create();
if (empty($costArr)) {
$error = $this->_rateErrorFactory->create();
$error->setCarrier('usps');
$error->setCarrierTitle($this->getConfigData('title'));
$error->setErrorMessage($this->getConfigData('specificerrmsg'));
$result->append($error);
} else {
foreach ($costArr as $method => $cost) {
$rate = $this->_rateMethodFactory->create();
$rate->setCarrier('usps');
$rate->setCarrierTitle($this->getConfigData('title'));
$rate->setMethod($method);
$rate->setMethodTitle($serviceCodeToActualNameMap[$method] ?? $this->getCode('method', $method));
$rate->setCost($costArr[$method]);
$rate->setPrice($this->getMethodPrice($cost, $method));
$result->append($rate);
}
}
return $result;
}
/**
* Get configuration data of carrier
*
* @param string $type
* @param string $code
* @return array|false
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
public function getCode($type, $code = '')
{
$codes = [
'method' => [
'0_FCLE' => __('First-Class Mail Large Envelope'),
'0_FCL' => __('First-Class Mail Letter'),
'0_FCP' => __('First-Class Package Service - Retail'),
'0_FCPC' => __('First-Class Mail Postcards'),
'1' => __('Priority Mail'),
'2' => __('Priority Mail Express Hold For Pickup'),
'3' => __('Priority Mail Express'),
'4' => __('Retail Ground'),
'6' => __('Media Mail'),
'7' => __('Library Mail'),
'13' => __('Priority Mail Express Flat Rate Envelope'),
'15' => __('First-Class Mail Large Postcards'),
'16' => __('Priority Mail Flat Rate Envelope'),
'17' => __('Priority Mail Medium Flat Rate Box'),
'22' => __('Priority Mail Large Flat Rate Box'),
'23' => __('Priority Mail Express Sunday/Holiday Delivery'),
'25' => __('Priority Mail Express Sunday/Holiday Delivery Flat Rate Envelope'),
'27' => __('Priority Mail Express Flat Rate Envelope Hold For Pickup'),
'28' => __('Priority Mail Small Flat Rate Box'),
'29' => __('Priority Mail Padded Flat Rate Envelope'),
'30' => __('Priority Mail Express Legal Flat Rate Envelope'),
'31' => __('Priority Mail Express Legal Flat Rate Envelope Hold For Pickup'),
'32' => __('Priority Mail Express Sunday/Holiday Delivery Legal Flat Rate Envelope'),
'33' => __('Priority Mail Hold For Pickup'),
'34' => __('Priority Mail Large Flat Rate Box Hold For Pickup'),
'35' => __('Priority Mail Medium Flat Rate Box Hold For Pickup'),
'36' => __('Priority Mail Small Flat Rate Box Hold For Pickup'),
'37' => __('Priority Mail Flat Rate Envelope Hold For Pickup'),
'38' => __('Priority Mail Gift Card Flat Rate Envelope'),
'39' => __('Priority Mail Gift Card Flat Rate Envelope Hold For Pickup'),
'40' => __('Priority Mail Window Flat Rate Envelope'),
'41' => __('Priority Mail Window Flat Rate Envelope Hold For Pickup'),
'42' => __('Priority Mail Small Flat Rate Envelope'),
'43' => __('Priority Mail Small Flat Rate Envelope Hold For Pickup'),
'44' => __('Priority Mail Legal Flat Rate Envelope'),
'45' => __('Priority Mail Legal Flat Rate Envelope Hold For Pickup'),
'46' => __('Priority Mail Padded Flat Rate Envelope Hold For Pickup'),
'47' => __('Priority Mail Regional Rate Box A'),
'48' => __('Priority Mail Regional Rate Box A Hold For Pickup'),
'49' => __('Priority Mail Regional Rate Box B'),
'50' => __('Priority Mail Regional Rate Box B Hold For Pickup'),
'53' => __('First-Class Package Service Hold For Pickup'),
'57' => __('Priority Mail Express Sunday/Holiday Delivery Flat Rate Boxes'),
'58' => __('Priority Mail Regional Rate Box C'),
'59' => __('Priority Mail Regional Rate Box C Hold For Pickup'),
'61' => __('First-Class Package Service'),
'62' => __('Priority Mail Express Padded Flat Rate Envelope'),
'63' => __('Priority Mail Express Padded Flat Rate Envelope Hold For Pickup'),
'64' => __('Priority Mail Express Sunday/Holiday Delivery Padded Flat Rate Envelope'),
'INT_1' => __('Priority Mail Express International'),
'INT_2' => __('Priority Mail International'),
'INT_4' => __('Global Express Guaranteed (GXG)'),
'INT_5' => __('Global Express Guaranteed Document'),
'INT_6' => __('Global Express Guaranteed Non-Document Rectangular'),
'INT_7' => __('Global Express Guaranteed Non-Document Non-Rectangular'),
'INT_8' => __('Priority Mail International Flat Rate Envelope'),
'INT_9' => __('Priority Mail International Medium Flat Rate Box'),
'INT_10' => __('Priority Mail Express International Flat Rate Envelope'),
'INT_11' => __('Priority Mail International Large Flat Rate Box'),
'INT_12' => __('USPS GXG Envelopes'),
'INT_13' => __('First-Class Mail International Letter'),
'INT_14' => __('First-Class Mail International Large Envelope'),
'INT_15' => __('First-Class Package International Service'),
'INT_16' => __('Priority Mail International Small Flat Rate Box'),
'INT_17' => __('Priority Mail Express International Legal Flat Rate Envelope'),
'INT_18' => __('Priority Mail International Gift Card Flat Rate Envelope'),
'INT_19' => __('Priority Mail International Window Flat Rate Envelope'),
'INT_20' => __('Priority Mail International Small Flat Rate Envelope'),
'INT_21' => __('First-Class Mail International Postcard'),
'INT_22' => __('Priority Mail International Legal Flat Rate Envelope'),
'INT_23' => __('Priority Mail International Padded Flat Rate Envelope'),
'INT_24' => __('Priority Mail International DVD Flat Rate priced box'),
'INT_25' => __('Priority Mail International Large Video Flat Rate priced box'),
'INT_27' => __('Priority Mail Express International Padded Flat Rate Envelope'),
'1058' => __('Ground Advantage™'),
'4058' => __('Ground Advantage™ HAZMAT'),
'6058' => __('Ground Advantage™ Parcel locker'),
'2058' => __('Ground Advantage™ Hold for pickup'),
'4096' => __('Ground Advantage™ Cubic HAZMAT'),
'1096' => __('Ground Advantage™ Cubic'),
'2096' => __('Ground Advantage™ Cubic Hold for pickup'),
'6096' => __('Ground Advantage™ Cubic Parcel locker')
],
'service_to_code' => [
'0_FCLE' => 'First Class',
'0_FCL' => 'First Class',
'0_FCP' => 'First Class',
'0_FCPC' => 'First Class',
'1' => 'Priority',
'2' => 'Priority Express',
'3' => 'Priority Express',
'4' => 'Retail Ground',
'6' => 'Media',
'7' => 'Library',
'13' => 'Priority Express',
'15' => 'First Class',
'16' => 'Priority',
'17' => 'Priority',
'22' => 'Priority',
'23' => 'Priority Express',
'25' => 'Priority Express',
'27' => 'Priority Express',
'28' => 'Priority',
'29' => 'Priority',
'30' => 'Priority Express',
'31' => 'Priority Express',
'32' => 'Priority Express',
'33' => 'Priority',
'34' => 'Priority',
'35' => 'Priority',
'36' => 'Priority',
'37' => 'Priority',
'38' => 'Priority',
'39' => 'Priority',
'40' => 'Priority',
'41' => 'Priority',
'42' => 'Priority',
'43' => 'Priority',
'44' => 'Priority',
'45' => 'Priority',
'46' => 'Priority',
'47' => 'Priority',
'48' => 'Priority',
'49' => 'Priority',
'50' => 'Priority',
'53' => 'First Class',
'57' => 'Priority Express',
'58' => 'Priority',
'59' => 'Priority',
'61' => 'First Class',
'62' => 'Priority Express',
'63' => 'Priority Express',
'64' => 'Priority Express',
'INT_1' => 'Priority Express',
'INT_2' => 'Priority',
'INT_4' => 'Priority Express',
'INT_5' => 'Priority Express',
'INT_6' => 'Priority Express',
'INT_7' => 'Priority Express',
'INT_8' => 'Priority',
'INT_9' => 'Priority',
'INT_10' => 'Priority Express',
'INT_11' => 'Priority',
'INT_12' => 'Priority Express',
'INT_13' => 'First Class',
'INT_14' => 'First Class',
'INT_15' => 'First Class',
'INT_16' => 'Priority',
'INT_17' => 'Priority',
'INT_18' => 'Priority',
'INT_19' => 'Priority',
'INT_20' => 'Priority',
'INT_21' => 'First Class',
'INT_22' => 'Priority',
'INT_23' => 'Priority',
'INT_24' => 'Priority',
'INT_25' => 'Priority',
'INT_27' => 'Priority Express',
'1058' => 'Ground Advantage',
'4058' => 'Ground Advantage',
'6058' => 'Ground Advantage',
'2058' => 'Ground Advantage',
'4096' => 'Ground Advantage',
'1096' => 'Ground Advantage',
'2096' => 'Ground Advantage',
'6096' => 'Ground Advantage',
],
'method_to_code' => [
'First-Class Mail Large Envelope' => '0_FCLE',
'First-Class Mail Letter' => '0_FCL',
'First-Class Package Service - Retail' => '0_FCP',
],
'first_class_mail_type' => ['LETTER' => __('Letter'), 'FLAT' => __('Flat'), 'PARCEL' => __('Parcel')],
'container' => [
'VARIABLE' => __('Variable'),
'SM FLAT RATE BOX' => __('Small Flat-Rate Box'),
'MD FLAT RATE BOX' => __('Medium Flat-Rate Box'),
'LG FLAT RATE BOX' => __('Large Flat-Rate Box'),
'FLAT RATE ENVELOPE' => __('Flat-Rate Envelope'),
'SM FLAT RATE ENVELOPE' => __('Small Flat-Rate Envelope'),
'WINDOW FLAT RATE ENVELOPE' => __('Window Flat-Rate Envelope'),
'GIFT CARD FLAT RATE ENVELOPE' => __('Gift Card Flat-Rate Envelope'),
'LEGAL FLAT RATE ENVELOPE' => __('Legal Flat-Rate Envelope'),
'PADDED FLAT RATE ENVELOPE' => __('Padded Flat-Rate Envelope'),
'RECTANGULAR' => __('Rectangular'),
'NONRECTANGULAR' => __('Non-rectangular'),
],
'containers_filter' => [
[
'containers' => ['VARIABLE'],
'filters' => [
'within_us' => [
'method' => [
'13', '27', '16', '22', '17', '28', '2', '3', '1', '33', '34', '35',
'36', '37', '42', '43', '53', '4', '6', '15', '23', '25', '57'
],
],
'from_us' => [
'method' => [
'INT_10', 'INT_8', 'INT_11', 'INT_9', 'INT_16', 'INT_20', 'INT_4',
'INT_12', 'INT_1', 'INT_2', 'INT_13', 'INT_14', 'INT_15'
],
],
],
],
[
'containers' => ['SM FLAT RATE BOX'],
'filters' => [
'within_us' => [
'method' => ['28', '57'],
],
'from_us' => [
'method' => ['INT_16', 'INT_24'],
],
]
],
[
'containers' => ['MD FLAT RATE BOX'],
'filters' => [
'within_us' => [
'method' => ['17', '57'],
],
'from_us' => [
'method' => ['INT_9', 'INT_24'],
],
]
],
[
'containers' => ['LG FLAT RATE BOX'],
'filters' => [
'within_us' => [
'method' => ['22', '57'],
],
'from_us' => [
'method' => ['INT_11', 'INT_24', 'INT_25'],
],
]
],
[
'containers' => ['SM FLAT RATE ENVELOPE'],
'filters' => [
'within_us' => [
'method' => ['42', '43'],
],
'from_us' => [
'method' => ['INT_20'],
],
]
],
[
'containers' => ['WINDOW FLAT RATE ENVELOPE'],
'filters' => [
'within_us' => [
'method' => ['40', '41'],
],
'from_us' => [
'method' => ['INT_19'],
],
]
],
[
'containers' => ['GIFT CARD FLAT RATE ENVELOPE'],
'filters' => [
'within_us' => [
'method' => ['38', '39'],
],
'from_us' => [
'method' => ['INT_18'],
],
]
],
[
'containers' => ['PADDED FLAT RATE ENVELOPE'],
'filters' => [
'within_us' => [
'method' => ['62', '63', '64', '46', '29'],
],
'from_us' => [
'method' => ['INT_27', 'INT_23'],
],
]
],
[
'containers' => ['LEGAL FLAT RATE ENVELOPE'],
'filters' => [
'within_us' => [
'method' => ['44', '45', '30', '31', '32'],
],
'from_us' => [
'method' => ['INT_17', 'INT_22'],
],
]
],
[
'containers' => ['FLAT RATE ENVELOPE'],
'filters' => [
'within_us' => [
'method' => ['16', '13', '27', '16', '15', '37', '42', '43', '25', '62'],
],
'from_us' => [
'method' => [
'INT_10', 'INT_8', 'INT_14', 'INT_20', 'INT_17', 'INT_18', 'INT_19', 'INT_22', 'INT_27'
],
],
]
],
[
'containers' => ['RECTANGULAR'],
'filters' => [
'within_us' => [
'method' => ['3', '1', '4', '6', '7', '61'],
],
'from_us' => [
'method' => ['INT_12', 'INT_1', 'INT_2', 'INT_15'],
],
]
],
[
'containers' => ['NONRECTANGULAR'],
'filters' => [
'within_us' => [
'method' => ['3', '1', '4', '6', '7'],
],
'from_us' => [
'method' => ['INT_4', 'INT_1', 'INT_2', 'INT_15'],
],
]
],
],
'size' => ['REGULAR' => __('Regular'), 'LARGE' => __('Large')],
'machinable' => ['true' => __('Yes'), 'false' => __('No')],
'delivery_confirmation_types' => ['True' => __('Not Required'), 'False' => __('Required')],
];
if (!isset($codes[$type])) {
return false;
} elseif ('' === $code) {
return $codes[$type];
}
if (!isset($codes[$type][$code])) {
return false;
} else {
return $codes[$type][$code];
}
}
/**
* Get tracking
*
* @param string|string[] $trackings
* @return Result|null
*/
public function getTracking($trackings)
{
$this->setTrackingReqeust();
if (!is_array($trackings)) {
$trackings = [$trackings];
}
$this->_getXmlTracking($trackings);
return $this->_result;
}
/**
* Set tracking request
*
* @return void
*/
protected function setTrackingReqeust()
{
$r = new \Magento\Framework\DataObject();
$userId = $this->getConfigData('userid');
$r->setUserId($userId);
$this->_rawTrackRequest = $r;
}
/**
* Send request for tracking
*
* @param string[] $trackings
* @return void
*/
protected function _getXmlTracking($trackings)
{
$r = $this->_rawTrackRequest;
foreach ($trackings as $tracking) {
$xml = $this->_xmlElFactory->create(
['data' => '<?xml version = "1.0" encoding = "UTF-8"?><TrackRequest/>']
);
$xml->addAttribute('USERID', $r->getUserId());
$trackid = $xml->addChild('TrackID');
$trackid->addAttribute('ID', $tracking);
$api = 'TrackV2';
$request = $xml->asXML();
$debugData = ['request' => $this->filterDebugData($request)];
$url = $this->getConfigData('gateway_url');
if (!$url) {
$url = $this->_defaultGatewayUrl;
}
$responseDeferred = $this->httpClient->request(
new Request(
$url . '?API=' . urlencode($api) . '&XML=' . urlencode($request),
Request::METHOD_GET,
[],
null
)
);
$responseBody = $responseDeferred->get()->getBody();
$debugData['result'] = $responseBody;
$this->_debug($debugData);
$this->_parseXmlTrackingResponse($tracking, $responseBody);
}
}
/**
* Parse xml tracking response
*
* @param string $trackingvalue
* @param string $response
* @return void
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*/
protected function _parseXmlTrackingResponse($trackingvalue, $response)
{
$errorTitle = __('For some reason we can\'t retrieve tracking info right now.');
$resultArr = [];
if (strlen(trim($response)) > 0) {
if (strpos(trim($response), '<?xml') === 0) {
$xml = $this->parseXml($response);
if (is_object($xml)) {
if (isset($xml->Number) && isset($xml->Description) && (string)$xml->Description != '') {
$errorTitle = (string)$xml->Description;
} elseif (isset($xml->TrackInfo)
&& isset($xml->TrackInfo->Error)
&& isset($xml->TrackInfo->Error->Description)
&& (string)$xml->TrackInfo->Error->Description != ''
) {
$errorTitle = (string)$xml->TrackInfo->Error->Description;
} else {
$errorTitle = __(
'Sorry, something went wrong. Please try again or contact us and we\'ll try to help.'
);
}
if (isset($xml->TrackInfo) && isset($xml->TrackInfo->TrackSummary)) {
$resultArr['tracksummary'] = (string)$xml->TrackInfo->TrackSummary;
}
}
}
}
if (!$this->_result) {
$this->_result = $this->_trackFactory->create();
}
$defaults = $this->getDefaults();
if ($resultArr) {
$tracking = $this->_trackStatusFactory->create();
$tracking->setCarrier('usps');
$tracking->setCarrierTitle($this->getConfigData('title'));
$tracking->setTracking($trackingvalue);
$tracking->setTrackSummary($resultArr['tracksummary']);
$this->_result->append($tracking);
} else {
$error = $this->_trackErrorFactory->create();
$error->setCarrier('usps');
$error->setCarrierTitle($this->getConfigData('title'));
$error->setTracking($trackingvalue);
$error->setErrorMessage($errorTitle);
$this->_result->append($error);
}
}
/**
* Get tracking response
*
* @return string
*/
public function getResponse()
{
$statuses = '';
if ($this->_result instanceof \Magento\Shipping\Model\Tracking\Result) {
if ($trackings = $this->_result->getAllTrackings()) {
foreach ($trackings as $tracking) {
if ($data = $tracking->getAllData()) {
if (!empty($data['track_summary'])) {
$statuses .= __($data['track_summary']);
} else {
$statuses .= __('Empty response');
}
}
}
}
}
return $statuses ?: __('Empty response');
}
/**
* Get allowed shipping methods
*
* @return array
*/
public function getAllowedMethods()
{
$allowed = explode(',', $this->getConfigData('allowed_methods') ?? '');
$arr = [];
foreach ($allowed as $k) {
$arr[$k] = $this->getCode('method', $k);
}
return $arr;
}
/**
* Return USPS county name by country ISO 3166-1-alpha-2 code
*
* Return false for unknown countries
*
* @param string $countryId
* @return string|false
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
*/
protected function _getCountryName($countryId)
{
$countries = [
'AD' => 'Andorra',
'AE' => 'United Arab Emirates',
'AF' => 'Afghanistan',
'AG' => 'Antigua and Barbuda',
'AI' => 'Anguilla',
'AL' => 'Albania',
'AM' => 'Armenia',
'AN' => 'Netherlands Antilles',
'AO' => 'Angola',
'AR' => 'Argentina',
'AT' => 'Austria',
'AU' => 'Australia',
'AW' => 'Aruba',
'AX' => 'Aland Island (Finland)',
'AZ' => 'Azerbaijan',
'BA' => 'Bosnia-Herzegovina',
'BB' => 'Barbados',
'BD' => 'Bangladesh',
'BE' => 'Belgium',
'BF' => 'Burkina Faso',
'BG' => 'Bulgaria',
'BH' => 'Bahrain',
'BI' => 'Burundi',
'BJ' => 'Benin',
'BM' => 'Bermuda',
'BN' => 'Brunei Darussalam',
'BO' => 'Bolivia',
'BR' => 'Brazil',
'BS' => 'Bahamas',
'BT' => 'Bhutan',
'BW' => 'Botswana',
'BY' => 'Belarus',
'BZ' => 'Belize',
'CA' => 'Canada',
'CC' => 'Cocos Island (Australia)',
'CD' => 'Congo, Democratic Republic of the',
'CF' => 'Central African Republic',
'CG' => 'Congo, Republic of the',
'CH' => 'Switzerland',
'CI' => 'Ivory Coast (Cote d Ivoire)',
'CK' => 'Cook Islands (New Zealand)',
'CL' => 'Chile',
'CM' => 'Cameroon',
'CN' => 'China',
'CO' => 'Colombia',
'CR' => 'Costa Rica',
'CU' => 'Cuba',
'CV' => 'Cape Verde',
'CX' => 'Christmas Island (Australia)',
'CY' => 'Cyprus',
'CZ' => 'Czech Republic',
'DE' => 'Germany',
'DJ' => 'Djibouti',
'DK' => 'Denmark',
'DM' => 'Dominica',
'DO' => 'Dominican Republic',
'DZ' => 'Algeria',
'EC' => 'Ecuador',
'EE' => 'Estonia',
'EG' => 'Egypt',
'ER' => 'Eritrea',
'ES' => 'Spain',
'ET' => 'Ethiopia',
'FI' => 'Finland',
'FJ' => 'Fiji',
'FK' => 'Falkland Islands',
'FM' => 'Micronesia, Federated States of',
'FO' => 'Faroe Islands',
'FR' => 'France',
'GA' => 'Gabon',
'GB' => 'United Kingdom of Great Britain and Northern Ireland',
'GD' => 'Grenada',
'GE' => 'Georgia, Republic of',
'GF' => 'French Guiana',
'GH' => 'Ghana',
'GI' => 'Gibraltar',
'GL' => 'Greenland',
'GM' => 'Gambia',
'GN' => 'Guinea',
'GP' => 'Guadeloupe',
'GQ' => 'Equatorial Guinea',
'GR' => 'Greece',
'GS' => 'South Georgia (Falkland Islands)',
'GT' => 'Guatemala',
'GW' => 'Guinea-Bissau',
'GY' => 'Guyana',
'HK' => 'Hong Kong',
'HN' => 'Honduras',
'HR' => 'Croatia',
'HT' => 'Haiti',
'HU' => 'Hungary',
'ID' => 'Indonesia',
'IE' => 'Ireland',
'IL' => 'Israel',
'IN' => 'India',
'IQ' => 'Iraq',
'IR' => 'Iran',
'IS' => 'Iceland',
'IT' => 'Italy',
'JM' => 'Jamaica',
'JO' => 'Jordan',
'JP' => 'Japan',
'KE' => 'Kenya',
'KG' => 'Kyrgyzstan',
'KH' => 'Cambodia',
'KI' => 'Kiribati',
'KM' => 'Comoros',
'KN' => 'Saint Kitts (Saint Christopher and Nevis)',
'KP' => 'North Korea (Korea, Democratic People\'s Republic of)',
'KR' => 'South Korea (Korea, Republic of)',
'KW' => 'Kuwait',
'KY' => 'Cayman Islands',
'KZ' => 'Kazakhstan',
'LA' => 'Laos',
'LB' => 'Lebanon',
'LC' => 'Saint Lucia',
'LI' => 'Liechtenstein',
'LK' => 'Sri Lanka',
'LR' => 'Liberia',
'LS' => 'Lesotho',
'LT' => 'Lithuania',
'LU' => 'Luxembourg',
'LV' => 'Latvia',
'LY' => 'Libya',
'MA' => 'Morocco',
'MC' => 'Monaco (France)',
'MD' => 'Moldova',
'MG' => 'Madagascar',
'MK' => 'Macedonia, Republic of',
'ML' => 'Mali',
'MM' => 'Burma',
'MN' => 'Mongolia',
'MO' => 'Macao',
'MQ' => 'Martinique',
'MR' => 'Mauritania',
'MS' => 'Montserrat',
'MT' => 'Malta',
'MU' => 'Mauritius',
'MV' => 'Maldives',
'MW' => 'Malawi',
'MX' => 'Mexico',
'MY' => 'Malaysia',
'MZ' => 'Mozambique',
'NA' => 'Namibia',
'NC' => 'New Caledonia',
'NE' => 'Niger',
'NG' => 'Nigeria',
'NI' => 'Nicaragua',
'NL' => 'Netherlands',
'NO' => 'Norway',
'NP' => 'Nepal',
'NR' => 'Nauru',
'NZ' => 'New Zealand',
'OM' => 'Oman',
'PA' => 'Panama',
'PE' => 'Peru',
'PF' => 'French Polynesia',
'PG' => 'Papua New Guinea',
'PH' => 'Philippines',
'PK' => 'Pakistan',
'PL' => 'Poland',
'PM' => 'Saint Pierre and Miquelon',
'PN' => 'Pitcairn Island',
'PT' => 'Portugal',
'PY' => 'Paraguay',
'QA' => 'Qatar',
'RE' => 'Reunion',
'RO' => 'Romania',
'RS' => 'Serbia',
'RU' => 'Russia',
'RW' => 'Rwanda',
'SA' => 'Saudi Arabia',
'SB' => 'Solomon Islands',
'SC' => 'Seychelles',
'SD' => 'Sudan',
'SE' => 'Sweden',
'SG' => 'Singapore',
'SH' => 'Saint Helena',
'SI' => 'Slovenia',
'SK' => 'Slovak Republic',
'SL' => 'Sierra Leone',
'SM' => 'San Marino',
'SN' => 'Senegal',
'SO' => 'Somalia',
'SR' => 'Suriname',
'ST' => 'Sao Tome and Principe',
'SV' => 'El Salvador',
'SY' => 'Syrian Arab Republic',
'SZ' => 'Eswatini',
'TC' => 'Turks and Caicos Islands',
'TD' => 'Chad',
'TG' => 'Togo',
'TH' => 'Thailand',
'TJ' => 'Tajikistan',
'TK' => 'Tokelau (Union Group) (Western Samoa)',
'TL' => 'East Timor (Timor-Leste, Democratic Republic of)',
'TM' => 'Turkmenistan',
'TN' => 'Tunisia',
'TO' => 'Tonga',
'TR' => 'Turkey',
'TT' => 'Trinidad and Tobago',
'TV' => 'Tuvalu',
'TW' => 'Taiwan',
'TZ' => 'Tanzania',
'UA' => 'Ukraine',
'UG' => 'Uganda',
'UY' => 'Uruguay',
'UZ' => 'Uzbekistan',
'VA' => 'Vatican City',
'VC' => 'Saint Vincent and the Grenadines',
'VE' => 'Venezuela',
'VG' => 'British Virgin Islands',
'VN' => 'Vietnam',
'VU' => 'Vanuatu',
'WF' => 'Wallis and Futuna Islands',
'WS' => 'Western Samoa',
'YE' => 'Yemen',
'YT' => 'Mayotte (France)',
'ZA' => 'South Africa',
'ZM' => 'Zambia',
'ZW' => 'Zimbabwe',
'US' => 'United States',
];
if (isset($countries[$countryId])) {
return $countries[$countryId];
}
return false;
}
/**
* Clean service name from unsupported strings and characters
*
* @param string $name
* @return string
*/
protected function _filterServiceName($name)
{
// phpcs:disable Magento2.Functions.DiscouragedFunction
$name = (string)preg_replace(
['~<[^/!][^>]+>.*</[^>]+>~sU', '~\<!--.*--\>~isU', '~<[^>]+>~is'],
'',
html_entity_decode($name)
);
// phpcs:enable Magento2.Functions.DiscouragedFunction
$name = str_replace('*', '', $name);
return $name;
}
/**
* Form XML for US shipment request
* As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be
* after <FromFirstName />
*
* @param \Magento\Framework\DataObject $request
* @return string
* @deprecated 100.2.1 This method should not be used anymore.
* @see \Magento\Usps\Model\Carrier::_doShipmentRequest method doc block.
*/
protected function _formUsExpressShipmentRequest(\Magento\Framework\DataObject $request)
{
$packageParams = $request->getPackageParams();
$packageWeight = $request->getPackageWeight();
if ($packageParams->getWeightUnits() != Weight::OUNCE) {
$packageWeight = round(
(float) $this->_carrierHelper->convertMeasureWeight(
(float)$request->getPackageWeight(),
$packageParams->getWeightUnits(),
Weight::OUNCE
)
);
}
list($fromZip5, $fromZip4) = $this->_parseZip($request->getShipperAddressPostalCode());
list($toZip5, $toZip4) = $this->_parseZip($request->getRecipientAddressPostalCode(), true);
$rootNode = 'ExpressMailLabelRequest';
// the wrap node needs for remove xml declaration above
$xmlWrap = $this->_xmlElFactory->create(['data' => '<?xml version = "1.0" encoding = "UTF-8"?><wrap/>']);
$xml = $xmlWrap->addChild($rootNode);
$xml->addAttribute('USERID', $this->getConfigData('userid'));
$xml->addAttribute('PASSWORD', $this->getConfigData('password'));
$xml->addChild('Option');
$xml->addChild('Revision');
$xml->addChild('EMCAAccount');
$xml->addChild('EMCAPassword');
$xml->addChild('ImageParameters');
$xml->addChild('FromFirstName', $request->getShipperContactPersonFirstName());
$xml->addChild('FromLastName', $request->getShipperContactPersonLastName());
$xml->addChild('FromFirm', $request->getShipperContactCompanyName());
$xml->addChild('FromAddress1', $request->getShipperAddressStreet2());
$xml->addChild('FromAddress2', $request->getShipperAddressStreet1());
$xml->addChild('FromCity', $request->getShipperAddressCity());
$xml->addChild('FromState', $request->getShipperAddressStateOrProvinceCode());
$xml->addChild('FromZip5', $fromZip5);
$xml->addChild('FromZip4', $fromZip4);
$xml->addChild('FromPhone', $request->getShipperContactPhoneNumber());
$xml->addChild('ToFirstName', $request->getRecipientContactPersonFirstName());
$xml->addChild('ToLastName', $request->getRecipientContactPersonLastName());
$xml->addChild('ToFirm', $request->getRecipientContactCompanyName());
$xml->addChild('ToAddress1', $request->getRecipientAddressStreet2());
$xml->addChild('ToAddress2', $request->getRecipientAddressStreet1());
$xml->addChild('ToCity', $request->getRecipientAddressCity());
$xml->addChild('ToState', $request->getRecipientAddressStateOrProvinceCode());
$xml->addChild('ToZip5', $toZip5);
$xml->addChild('ToZip4', $toZip4);
$xml->addChild('ToPhone', $request->getRecipientContactPhoneNumber());
$xml->addChild('WeightInOunces', $packageWeight);
$xml->addChild('WaiverOfSignature', $packageParams->getDeliveryConfirmation());
$xml->addChild('POZipCode');
$xml->addChild('ImageType', 'PDF');
$xml = $xmlWrap->{$rootNode}->asXML();
return $xml;
}
/**
* Form XML for US Signature Confirmation request
* As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be
* after <FromFirstName />
*
* @param \Magento\Framework\DataObject $request
* @param string $serviceType
* @return string
* @throws \Exception
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
protected function _formUsSignatureConfirmationShipmentRequest(\Magento\Framework\DataObject $request, $serviceType)
{
switch ($serviceType) {
case 'PRIORITY':
case 'Priority':
$serviceType = 'Priority';
break;
case 'FIRST CLASS':
case 'First Class':
$serviceType = 'First Class';
break;
case 'STANDARD':
case 'Standard Post':
case 'Retail Ground':
$serviceType = 'Retail Ground';
break;
case 'MEDIA':
case 'Media':
$serviceType = 'Media Mail';
break;
case 'LIBRARY':
case 'Library':
$serviceType = 'Library Mail';
break;
default:
throw new \InvalidArgumentException(__('Service type does not match'));
}
$packageParams = $request->getPackageParams();
$packageWeight = $request->getPackageWeight();
if ($packageParams->getWeightUnits() != Weight::OUNCE) {
$packageWeight = round(
(float) $this->_carrierHelper->convertMeasureWeight(
(float)$request->getPackageWeight(),
$packageParams->getWeightUnits(),
Weight::OUNCE
)
);
}
list($fromZip5, $fromZip4) = $this->_parseZip($request->getShipperAddressPostalCode());
list($toZip5, $toZip4) = $this->_parseZip($request->getRecipientAddressPostalCode(), true);
if ($this->getConfigData('mode')) {
$rootNode = 'SignatureConfirmationV3.0Request';
} else {
$rootNode = 'SigConfirmCertifyV3.0Request';
}
// the wrap node needs for remove xml declaration above
$xmlWrap = $this->_xmlElFactory->create(['data' => '<?xml version = "1.0" encoding = "UTF-8"?><wrap/>']);
$xml = $xmlWrap->addChild($rootNode);
$xml->addAttribute('USERID', $this->getConfigData('userid'));
$xml->addChild('Option', 1);
$xml->addChild('ImageParameters');
$xml->addChild('FromName', $request->getShipperContactPersonName());
$xml->addChild('FromFirm', $request->getShipperContactCompanyName());
$xml->addChild('FromAddress1', $request->getShipperAddressStreet2());
$xml->addChild('FromAddress2', $request->getShipperAddressStreet1());
$xml->addChild('FromCity', $request->getShipperAddressCity());
$xml->addChild('FromState', $request->getShipperAddressStateOrProvinceCode());
$xml->addChild('FromZip5', $fromZip5);
$xml->addChild('FromZip4', $fromZip4);
$xml->addChild('ToName', $request->getRecipientContactPersonName());
$xml->addChild('ToFirm', $request->getRecipientContactCompanyName());
$xml->addChild('ToAddress1', $request->getRecipientAddressStreet2());
$xml->addChild('ToAddress2', $request->getRecipientAddressStreet1());
$xml->addChild('ToCity', $request->getRecipientAddressCity());
$xml->addChild('ToState', $request->getRecipientAddressStateOrProvinceCode());
$xml->addChild('ToZip5', $toZip5);
$xml->addChild('ToZip4', $toZip4);
$xml->addChild('WeightInOunces', $packageWeight);
$xml->addChild('ServiceType', $serviceType);
$xml->addChild('WaiverOfSignature', $packageParams->getDeliveryConfirmation());
$xml->addChild('ImageType', 'PDF');
$xml = $xmlWrap->{$rootNode}->asXML();
return $xml;
}
/**
* Convert decimal weight into pound-ounces format
*
* @param float $weightInPounds
* @return float[]
*/
protected function _convertPoundOunces($weightInPounds)
{
$weightInOunces = ceil($weightInPounds * self::OUNCES_POUND);
$pounds = floor($weightInOunces / self::OUNCES_POUND);
$ounces = $weightInOunces % self::OUNCES_POUND;
return [$pounds, $ounces];
}
/**
* Form XML for international shipment request
* As integration guide it is important to follow appropriate sequence for tags e.g.: <FromLastName /> must be
* after <FromFirstName />
*
* @param \Magento\Framework\DataObject $request
* @return string
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
* @deprecated 100.2.1 Should not be used anymore.
* @see \Magento\Usps\Model\Carrier::_doShipmentRequest doc block.
*/
protected function _formIntlShipmentRequest(\Magento\Framework\DataObject $request)
{
$packageParams = $request->getPackageParams();
$height = $packageParams->getHeight();
$width = $packageParams->getWidth();
$length = $packageParams->getLength();
$girth = $packageParams->getGirth();
$packageWeight = $request->getPackageWeight();
if ($packageParams->getWeightUnits() != Weight::POUND) {
$packageWeight = $this->_carrierHelper->convertMeasureWeight(
(float)$request->getPackageWeight(),
$packageParams->getWeightUnits(),
Weight::POUND
);
}
if ($packageParams->getDimensionUnits() != Length::INCH) {
$length = round(
(float) $this->_carrierHelper->convertMeasureDimension(
(float)$packageParams->getLength(),
$packageParams->getDimensionUnits(),
Length::INCH
)
);
$width = round(
(float) $this->_carrierHelper->convertMeasureDimension(
(float)$packageParams->getWidth(),
$packageParams->getDimensionUnits(),
Length::INCH
)
);
$height = round(
(float) $this->_carrierHelper->convertMeasureDimension(
(float)$packageParams->getHeight(),
$packageParams->getDimensionUnits(),
Length::INCH
)
);
}
if ($packageParams->getGirthDimensionUnits() != Length::INCH) {
$girth = round(
(float) $this->_carrierHelper->convertMeasureDimension(
(float)$packageParams->getGirth(),
$packageParams->getGirthDimensionUnits(),
Length::INCH
)
);
}
$container = $request->getPackagingType();
switch ($container) {
case 'VARIABLE':
$container = 'VARIABLE';
break;
case 'FLAT RATE ENVELOPE':
$container = 'FLATRATEENV';
break;
case 'FLAT RATE BOX':
$container = 'FLATRATEBOX';
break;
case 'RECTANGULAR':
$container = 'RECTANGULAR';
break;
case 'NONRECTANGULAR':
$container = 'NONRECTANGULAR';
break;
default:
$container = 'VARIABLE';
}
$shippingMethod = $request->getShippingMethod();
list($fromZip5, $fromZip4) = $this->_parseZip($request->getShipperAddressPostalCode());
// the wrap node needs for remove xml declaration above
$xmlWrap = $this->_xmlElFactory->create(['data' => '<?xml version = "1.0" encoding = "UTF-8"?><wrap/>']);
$method = '';
$service = $this->getCode('service_to_code', $shippingMethod);
if ($service == 'Priority') {
$method = 'Priority';
$rootNode = 'PriorityMailIntlRequest';
$xml = $xmlWrap->addChild($rootNode);
} else {
if ($service == 'First Class') {
$method = 'FirstClass';
$rootNode = 'FirstClassMailIntlRequest';
$xml = $xmlWrap->addChild($rootNode);
} else {
$method = 'Express';
$rootNode = 'ExpressMailIntlRequest';
$xml = $xmlWrap->addChild($rootNode);
}
}
$xml->addAttribute('USERID', $this->getConfigData('userid'));
$xml->addAttribute('PASSWORD', $this->getConfigData('password'));
$xml->addChild('Option');
$xml->addChild('Revision', self::DEFAULT_REVISION);
$xml->addChild('ImageParameters');
$xml->addChild('FromFirstName', $request->getShipperContactPersonFirstName());
$xml->addChild('FromLastName', $request->getShipperContactPersonLastName());
$xml->addChild('FromFirm', $request->getShipperContactCompanyName());
$xml->addChild('FromAddress1', $request->getShipperAddressStreet2());
$xml->addChild('FromAddress2', $request->getShipperAddressStreet1());
$xml->addChild('FromCity', $request->getShipperAddressCity());
$xml->addChild('FromState', $request->getShipperAddressStateOrProvinceCode());
$xml->addChild('FromZip5', $fromZip5);
$xml->addChild('FromZip4', $fromZip4);
$xml->addChild('FromPhone', $request->getShipperContactPhoneNumber());
if ($method != 'FirstClass') {
if ($request->getReferenceData()) {
$referenceData = $request->getReferenceData() . ' P' . $request->getPackageId();
} else {
$referenceData = $request->getOrderShipment()->getOrder()->getIncrementId() .
' P' .
$request->getPackageId();
}
$xml->addChild('FromCustomsReference', 'Order #' . $referenceData);
}
$xml->addChild('ToFirstName', $request->getRecipientContactPersonFirstName());
$xml->addChild('ToLastName', $request->getRecipientContactPersonLastName());
$xml->addChild('ToFirm', $request->getRecipientContactCompanyName());
$xml->addChild('ToAddress1', $request->getRecipientAddressStreet1());
$xml->addChild('ToAddress2', $request->getRecipientAddressStreet2());
$xml->addChild('ToCity', $request->getRecipientAddressCity());
$xml->addChild('ToProvince', $request->getRecipientAddressStateOrProvinceCode());
$xml->addChild('ToCountry', $this->_getCountryName($request->getRecipientAddressCountryCode()));
$xml->addChild('ToPostalCode', $request->getRecipientAddressPostalCode());
$xml->addChild('ToPOBoxFlag', 'N');
$xml->addChild('ToPhone', $request->getRecipientContactPhoneNumber());
$xml->addChild('ToFax');
$xml->addChild('ToEmail');
if ($method != 'FirstClass') {
$xml->addChild('NonDeliveryOption', 'Return');
}
if ($method == 'FirstClass') {
if (stripos($shippingMethod, 'Letter') !== false) {
$xml->addChild('FirstClassMailType', 'LETTER');
} else {
if (stripos($shippingMethod, 'Flat') !== false) {
$xml->addChild('FirstClassMailType', 'FLAT');
} else {
$xml->addChild('FirstClassMailType', 'PARCEL');
}
}
}
if ($method != 'FirstClass') {
$xml->addChild('Container', $container);
}
$shippingContents = $xml->addChild('ShippingContents');
$packageItems = $request->getPackageItems();
// get countries of manufacture
$countriesOfManufacture = [];
$productIds = [];
foreach ($packageItems as $itemShipment) {
$item = new \Magento\Framework\DataObject();
$item->setData($itemShipment);
$productIds[] = $item->getProductId();
}
$productCollection = $this->_productCollectionFactory->create()->addStoreFilter(
$request->getStoreId()
)->addFieldToFilter(
'entity_id',
['in' => $productIds]
)->addAttributeToSelect(
'country_of_manufacture'
);
foreach ($productCollection as $product) {
$countriesOfManufacture[$product->getId()] = $product->getCountryOfManufacture();
}
$packagePoundsWeight = $packageOuncesWeight = 0;
// for ItemDetail
foreach ($packageItems as $itemShipment) {
$item = new \Magento\Framework\DataObject();
$item->setData($itemShipment);
$itemWeight = $item->getWeight() * $item->getQty();
if ($packageParams->getWeightUnits() != Weight::POUND) {
$itemWeight = $this->_carrierHelper->convertMeasureWeight(
$itemWeight,
$packageParams->getWeightUnits(),
Weight::POUND
);
}
if (!empty($countriesOfManufacture[$item->getProductId()])) {
$countryOfManufacture = $this->_getCountryName($countriesOfManufacture[$item->getProductId()]);
} else {
$countryOfManufacture = '';
}
$itemDetail = $shippingContents->addChild('ItemDetail');
$itemDetail->addChild('Description', $item->getName());
$ceiledQty = ceil($item->getQty());
if ($ceiledQty < 1) {
$ceiledQty = 1;
}
$individualItemWeight = $itemWeight / $ceiledQty;
$itemDetail->addChild('Quantity', $ceiledQty);
$itemDetail->addChild('Value', sprintf('%.2F', $item->getCustomsValue() * $item->getQty()));
list($individualPoundsWeight, $individualOuncesWeight) = $this->_convertPoundOunces($individualItemWeight);
$itemDetail->addChild('NetPounds', $individualPoundsWeight);
$itemDetail->addChild('NetOunces', sprintf('%.2F', $individualOuncesWeight));
$itemDetail->addChild('HSTariffNumber', 0);
$itemDetail->addChild('CountryOfOrigin', $countryOfManufacture);
list($itemPoundsWeight, $itemOuncesWeight) = $this->_convertPoundOunces($itemWeight);
$packagePoundsWeight += $itemPoundsWeight;
$packageOuncesWeight += $itemOuncesWeight;
}
$additionalPackagePoundsWeight = floor($packageOuncesWeight / self::OUNCES_POUND);
$packagePoundsWeight += $additionalPackagePoundsWeight;
$packageOuncesWeight -= $additionalPackagePoundsWeight * self::OUNCES_POUND;
if ($packagePoundsWeight + $packageOuncesWeight / self::OUNCES_POUND < $packageWeight) {
list($packagePoundsWeight, $packageOuncesWeight) = $this->_convertPoundOunces($packageWeight);
}
$xml->addChild('GrossPounds', $packagePoundsWeight);
$xml->addChild('GrossOunces', $packageOuncesWeight);
if ($packageParams->getContentType() == 'OTHER' && $packageParams->getContentTypeOther() != null) {
$xml->addChild('ContentType', $packageParams->getContentType());
$xml->addChild('ContentTypeOther ', $packageParams->getContentTypeOther());
} else {
$xml->addChild('ContentType', $packageParams->getContentType());
}
$xml->addChild('Agreement', 'y');
$xml->addChild('ImageType', 'PDF');
$xml->addChild('ImageLayout', 'ALLINONEFILE');
if ($method == 'FirstClass') {
$xml->addChild('Container', $container);
}
// set size
if ($packageParams->getSize()) {
$xml->addChild('Size', $packageParams->getSize());
}
// set dimensions
$xml->addChild('Length', $length);
$xml->addChild('Width', $width);
$xml->addChild('Height', $height);
if ($girth) {
$xml->addChild('Girth', $girth);
}
$xml = $xmlWrap->{$rootNode}->asXML();
return $xml;
}
/**
* Do shipment request to carrier web service, obtain Print Shipping Labels and process errors in response
*
* @param \Magento\Framework\DataObject $request
* @return \Magento\Framework\DataObject
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @deprecated 100.2.1 This method must not be used anymore. Starting from 23.02.2018 USPS eliminates API usage for
* free shipping labels generating.
* @see no alternatives
*/
protected function _doShipmentRequest(\Magento\Framework\DataObject $request)
{
$this->_prepareShipmentRequest($request);
$result = new \Magento\Framework\DataObject();
$service = $this->getCode('service_to_code', $request->getShippingMethod());
$recipientUSCountry = $this->_isUSCountry($request->getRecipientAddressCountryCode());
if ($recipientUSCountry && $service == 'Priority Express') {
$requestXml = $this->_formUsExpressShipmentRequest($request);
$api = 'ExpressMailLabel';
} else {
if ($recipientUSCountry) {
$requestXml = $this->_formUsSignatureConfirmationShipmentRequest($request, $service);
if ($this->getConfigData('mode')) {
$api = 'SignatureConfirmationV3';
} else {
$api = 'SignatureConfirmationCertifyV3';
}
} else {
if ($service == 'First Class') {
$requestXml = $this->_formIntlShipmentRequest($request);
$api = 'FirstClassMailIntl';
} else {
if ($service == 'Priority') {
$requestXml = $this->_formIntlShipmentRequest($request);
$api = 'PriorityMailIntl';
} else {
$requestXml = $this->_formIntlShipmentRequest($request);
$api = 'ExpressMailIntl';
}
}
}
}
$debugData = ['request' => $this->filterDebugData($requestXml)];
$url = $this->getConfigData('gateway_secure_url');
if (!$url) {
$url = $this->_defaultGatewayUrl;
}
/** @var LaminasClient $client */
$client = $this->_httpClientFactory->create();
$client->setUri($url);
$client->setOptions(['maxredirects' => 0, 'timeout' => 30]);
$client->setParameterGet(
[
'API' => $api,
'XML' => $requestXml
]
);
$response = $client->send()->getBody();
$response = $this->parseXml($response);
if ($response !== false) {
if ($response->getName() == 'Error') {
$debugData['result'] = [
'error' => $response->Description,
'code' => $response->Number,
'xml' => $response->asXML(),
];
$this->_debug($debugData);
$result->setErrors($debugData['result']['error']);
} else {
if ($recipientUSCountry && $service == 'Priority Express') {
// phpcs:disable Magento2.Functions.DiscouragedFunction
$labelContent = base64_decode((string)$response->EMLabel);
$trackingNumber = (string)$response->EMConfirmationNumber;
} elseif ($recipientUSCountry) {
// phpcs:disable Magento2.Functions.DiscouragedFunction
$labelContent = base64_decode((string)$response->SignatureConfirmationLabel);
$trackingNumber = (string)$response->SignatureConfirmationNumber;
} else {
// phpcs:disable Magento2.Functions.DiscouragedFunction
$labelContent = base64_decode((string)$response->LabelImage);
$trackingNumber = (string)$response->BarcodeNumber;
}
$result->setShippingLabelContent($labelContent);
$result->setTrackingNumber($trackingNumber);
}
}
$result->setGatewayResponse($response);
$debugData['result'] = $response;
$this->_debug($debugData);
return $result;
}
/**
* Return container types of carrier
*
* @param \Magento\Framework\DataObject|null $params
* @return array|bool
*/
public function getContainerTypes(\Magento\Framework\DataObject $params = null)
{
if ($params === null) {
return $this->_getAllowedContainers();
}
return $this->_isUSCountry($params->getCountryRecipient()) ? [] : $this->_getAllowedContainers($params);
}
/**
* Return all container types of carrier
*
* @return array|bool
*/
public function getContainerTypesAll()
{
return $this->getCode('container');
}
/**
* Return structured data of containers witch related with shipping methods
*
* @return array|bool
*/
public function getContainerTypesFilter()
{
return $this->getCode('containers_filter');
}
/**
* Return delivery confirmation types of carrier
*
* @param \Magento\Framework\DataObject|null $params
* @return array
*/
public function getDeliveryConfirmationTypes(\Magento\Framework\DataObject $params = null)
{
if ($params == null) {
return [];
}
$countryRecipient = $params->getCountryRecipient();
if ($this->_isUSCountry($countryRecipient)) {
return $this->getCode('delivery_confirmation_types');
} else {
return [];
}
}
/**
* Check whether girth is allowed for the USPS
*
* @param null|string $countyDest
* @param null|string $carrierMethodCode
* @return bool
*/
public function isGirthAllowed($countyDest = null, $carrierMethodCode = null)
{
return !($this->_isUSCountry($countyDest) && $this->dataHelper->displayGirthValue($carrierMethodCode));
}
/**
* Return content types of package
*
* @param \Magento\Framework\DataObject $params
* @return array
*/
public function getContentTypes(\Magento\Framework\DataObject $params)
{
$countryShipper = $params->getCountryShipper();
$countryRecipient = $params->getCountryRecipient();
if ($countryShipper == self::USA_COUNTRY_ID && $countryRecipient != self::USA_COUNTRY_ID) {
return [
'MERCHANDISE' => __('Merchandise'),
'SAMPLE' => __('Sample'),
'GIFT' => __('Gift'),
'DOCUMENTS' => __('Documents'),
'RETURN' => __('Return'),
'OTHER' => __('Other')
];
}
return [];
}
/**
* Parse zip from string to zip5-zip4
*
* @param string $zipString
* @param bool $returnFull
* @return string[]
*/
protected function _parseZip($zipString, $returnFull = false)
{
$zip4 = '';
$zip5 = '';
$zip = [$zipString];
if ($zipString !== null && preg_match('/[\\d\\w]{5}\\-[\\d\\w]{4}/', $zipString) != 0) {
$zip = explode('-', $zipString);
}
$count = count($zip);
for ($i = 0; $i < $count; ++$i) {
if (strlen($zip[$i] ?? '') == 5) {
$zip5 = $zip[$i];
} elseif (strlen($zip[$i] ?? '') == 4) {
$zip4 = $zip[$i];
}
}
if (empty($zip5) && empty($zip4) && $returnFull) {
$zip5 = $zipString;
}
return [$zip5, $zip4];
}
/**
* Check availability of post service
*
* @param \SimpleXMLElement $service
* @return boolean
*/
private function isServiceAvailable(\SimpleXMLElement $service)
{
// Allow services which which don't provide any ExtraServices
if (empty($service->ExtraServices->children()->count())) {
return true;
}
foreach ($service->ExtraServices->children() as $child) {
if (filter_var($child->Available, FILTER_VALIDATE_BOOLEAN)) {
return true;
}
}
return false;
}
/**
* Replace sensitive fields.
*
* Replace sensitive fields, which specified as attributes of xml node.
* For followed xml:
* ```xml
* <RateV4Request USERID="1">
* <Revision>2</Revision>
* </RateV4Request>
* ```xml
* the `USERID` attribute value will be replaced by specified mask
*
* @param string $data
* @return string
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*/
protected function filterDebugData($data)
{
try {
$xml = new \SimpleXMLElement($data);
$attributes = $xml->attributes();
/** @var \SimpleXMLElement $attribute */
foreach ($attributes as $key => $attribute) {
if (in_array((string) $key, $this->_debugReplacePrivateDataKeys)) {
$attributes[$key] = self::DEBUG_KEYS_MASK;
}
}
$data = $xml->asXML();
} catch (\Exception $e) {
return '*Failed to read XML*';
}
return $data;
}
/**
* Creates packages for rate request.
*
* @param float $totalWeight
* @param array $packages
* @return array
*/
private function createPackages(float $totalWeight, array $packages): array
{
if (empty($packages)) {
$dividedWeight = $this->getTotalNumOfBoxes($totalWeight);
for ($i=0; $i < $this->_numBoxes; $i++) {
$packages[$i]['weight_pounds'] = floor($dividedWeight);
$ounces = ($dividedWeight - floor($dividedWeight)) * self::OUNCES_POUND;
$packages[$i]['weight_ounces'] = sprintf('%.' . self::$weightPrecision . 'f', $ounces);
}
} else {
foreach ($packages as $key => $package) {
$packages[$key]['weight_pounds'] = floor($package['weight']);
$ounces = ($package['weight'] - floor($package['weight'])) * self::OUNCES_POUND;
$packages[$key]['weight_ounces'] = sprintf('%.' . self::$weightPrecision . 'f', $ounces);
}
}
$this->_numBoxes = count($packages);
return $packages;
}
}