Tax::serializeEffectiveRate() - Code Metrics - eBayEnterprise/RetailOrderManagement-SDK - Measure and Improve Code Quality continuously with Scrutinizer

Tax::serializeEffectiveRate() A
last analyzed 2016-01-20 19:07 UTC

↳ Parent: Tax

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * Copyright (c) 2013-2014 eBay Enterprise, Inc.
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * @copyright   Copyright (c) 2013-2015 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */

namespace eBayEnterprise\RetailOrderManagement\Payload\Order;

use eBayEnterprise\RetailOrderManagement\Payload\IPayload;
use eBayEnterprise\RetailOrderManagement\Payload\IPayloadMap;
use eBayEnterprise\RetailOrderManagement\Payload\ISchemaValidator;
use eBayEnterprise\RetailOrderManagement\Payload\IValidatorIterator;
use eBayEnterprise\RetailOrderManagement\Payload\TPayload;
use eBayEnterprise\RetailOrderManagement\Payload\TPayloadLogger;
use eBayEnterprise\RetailOrderManagement\Payload\Payment\TAmount;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

class Tax implements ITax
{
    use TPayload, TPayloadLogger, TAmount;

    const ROOT_NODE = 'Tax';

    /** @var string */
    protected $type;
    /** @var string */
    protected $taxability;
    /** @var string */
    protected $situs;
    /** @var string */
    protected $jurisdiction;
    /** @var string */
    protected $jurisdictionLevel;
    /** @var string */
    protected $jurisdictionId;
    /** @var string */
    protected $imposition;
    /** @var string */
    protected $impositionType;
    /** @var float */
    protected $effectiveRate;
    /** @var float */
    protected $taxableAmount;
    /** @var float */
    protected $calculatedTax;
    /** @var string */
    protected $sellerRegistrationId;
    /** @var array */
    protected $allowedTaxTypes = [
        self::TAX_TYPE_SALES,
        self::TAX_TYPE_SELLER_USE,
        self::TAX_TYPE_CONSUMER_USE,
        self::TAX_TYPE_VAT,
        self::TAX_TYPE_IMPORT_VAT,
        self::TAX_TYPE_NONE,
    ];
    /** @var array */
    protected $allowedTaxabilities = [
        self::TAXABILITY_TAXABLE,
        self::TAXABILITY_NONTAXABLE,
        self::TAXABILITY_EXEMPT,
        self::TAXABILITY_DPPAPPLIED,
        self::TAXABILITY_NO_TAX,
        self::TAXABILITY_DEFERRED,
    ];
    /** @var array */
    protected $allowedSituses = [
        self::SITUS_ADMINISTRATIVE_DESTINATION,
        self::SITUS_ADMINISTRATIVE_ORIGIN,
        self::SITUS_DESTINATION,
        self::SITUS_PHYSICAL_ORIGIN,
    ];
    /** @var array */
    protected $allowedJurisdictionLevels = [
        self::JURISDICTION_LEVEL_APO,
        self::JURISDICTION_LEVEL_BOROUGH,
        self::JURISDICTION_LEVEL_CITY,
        self::JURISDICTION_LEVEL_COUNTRY,
        self::JURISDICTION_LEVEL_COUNTY,
        self::JURISDICTION_LEVEL_DISTRICT,
        self::JURISDICTION_LEVEL_FPO,
        self::JURISDICTION_LEVEL_LOCAL_IMPROVEMENT_DISTRICT,
        self::JURISDICTION_LEVEL_PARISH,
        self::JURISDICTION_LEVEL_SPECIAL_PURPOSE_DISTRICT,
        self::JURISDICTION_LEVEL_STATE,
        self::JURISDICTION_LEVEL_TERRITORY,
        self::JURISDICTION_LEVEL_TOWNSHIP,
        self::JURISDICTION_LEVEL_TRADE_BLOCK,
        self::JURISDICTION_LEVEL_TRANSIT_DISTRICT,
        self::JURISDICTION_LEVEL_PROVINCE,
    ];

    /**
     * @param IValidatorIterator
     * @param ISchemaValidator
     * @param IPayloadMap
     * @param LoggerInterface
     * @param IPayload
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function __construct(
        IValidatorIterator $validators,
        ISchemaValidator $schemaValidator,
        IPayloadMap $payloadMap,
        LoggerInterface $logger,
        IPayload $parentPayload = null
    ) {
        $this->logger = $logger;

        $this->validators = $validators;
        $this->parentPayload = $parentPayload;

        $this->extractionPaths = [
            'type' => 'string(@taxType)',
            'taxability' => 'string(@taxability)',
            'situs' => 'string(x:Situs)',
            'effectiveRate' => 'number(x:EffectiveRate)',
            'calculatedTax' => 'number(x:CalculatedTax)',
        ];
        $this->optionalExtractionPaths = [
            'jurisdiction' => 'x:Jurisdiction',
            'jurisdictionLevel' => 'x:Jurisdiction/@jurisdictionLevel',
            'jurisdictionId' => 'x:Jurisdiction/@jurisdictionId',
            'imposition' => 'x:Imposition',
            'impositionType' => 'x:Imposition/@impositionType',
            'taxableAmount' => 'x:TaxableAmount',
            'sellerRegistrationId' => 'x:SellerRegistrationId',
        ];
    }

    public function getType()
    {
        return $this->type;
    }

    public function setType($type)
    {
        $this->type = in_array($type, $this->allowedTaxTypes) ? $type : null;
        return $this;
    }

    public function getTaxability()
    {
        return $this->taxability;
    }

    public function setTaxability($taxability)
    {
        $this->taxability = in_array($taxability, $this->allowedTaxabilities) ? $taxability : null;
        return $this;
    }

    public function getSitus()
    {
        return $this->situs;
    }

    public function setSitus($situs)
    {
        $this->situs = in_array($situs, $this->allowedSituses) ? $situs : null;
        return $this;
    }

    public function getJurisdiction()
    {
        return $this->jurisdiction;
    }

    public function setJurisdiction($jurisdiction)
    {
        $this->jurisdiction = $jurisdiction;
        return $this;
    }

    public function getJurisdictionLevel()
    {
        return $this->jurisdictionLevel;
    }

    public function setJurisdictionLevel($jurisdictionLevel)

    {
        $isAllowed = in_array($jurisdictionLevel, $this->allowedJurisdictionLevels);
        $this->jurisdictionLevel = $isAllowed ? $jurisdictionLevel : null;
        if (!$isAllowed) {
            $logData = ['jurisdiction_level' => $jurisdictionLevel];
            $this->logger->warning(
                'Jurisdiction Level "{jurisdiction_level}" is not allowed.',
                $this->getLogContextData(__CLASS__, $logData)
            );
        }
        return $this;
    }
    public function getJurisdictionId()
    {
        return $this->jurisdictionId;
    }

    public function setJurisdictionId($jurisdictionId)
    {
        $this->jurisdictionId = $jurisdictionId;
        return $this;
    }

    public function getImposition()
    {
        return $this->imposition;
    }

    public function setImposition($imposition)
    {
        $this->imposition = $imposition;
        return $this;
    }

    public function getImpositionType()
    {
        return $this->impositionType;
    }

    public function setImpositionType($impositionType)
    {
        $this->impositionType = $this->cleanString($impositionType, 60);
        return $this;
    }

    public function getEffectiveRate()
    {
        return $this->effectiveRate;
    }

    public function setEffectiveRate($effectiveRate)
    {
        $this->effectiveRate = $effectiveRate;
        return $this;
    }

    public function getTaxableAmount()
    {
        return $this->taxableAmount;
    }

    public function setTaxableAmount($taxableAmount)
    {
        $this->taxableAmount = $this->sanitizeAmount($taxableAmount);
        return $this;
    }

    public function getCalculatedTax()
    {
        return $this->calculatedTax;
    }

    public function setCalculatedTax($calculatedTax)
    {
        $this->calculatedTax = $this->sanitizeAmount($calculatedTax);
        return $this;
    }

    public function getSellerRegistrationId()
    {
        return $this->sellerRegistrationId;
    }

    public function setSellerRegistrationId($sellerRegistrationId)
    {
        $this->sellerRegistrationId = $sellerRegistrationId;
        return $this;
    }

    protected function serializeContents()
    {
        return "<Situs>{$this->xmlEncode($this->getSitus())}</Situs>"
            . $this->serializeJurisdiction()
            . $this->serializeImposition()
            . $this->serializeEffectiveRate()
            . $this->serializeOptionalAmount('TaxableAmount', $this->getTaxableAmount())
            . $this->serializeAmount('CalculatedTax', $this->getCalculatedTax())
            . $this->serializeOptionalXmlEncodedValue('SellerRegistrationId', $this->getSellerRegistrationId());
    }

    /**
     * Serialize the EffectiveRate.
     * Despite the xsd documentation, this value should not be rounded.
     *
     * @return string
     */
    protected function serializeEffectiveRate()
    {
        // As a side effect, sprintf will prevent any xml-unsafe value if getEffectiveRate is a string.
        return sprintf('<EffectiveRate>%F</EffectiveRate>', $this->getEffectiveRate());
    }

    /**
     * Serialize the tax jurisdiction, id and level.
     *
     * @return string
     */
    protected function serializeJurisdiction()
    {
        $jurisdiction = $this->getJurisdiction();
        return !is_null($jurisdiction)
            ? '<Jurisdiction'
                . $this->serializeOptionalAttribute('jurisdictionId', $this->xmlEncode($this->getJurisdictionId()))
                . $this->serializeOptionalAttribute('jurisdictionLevel', $this->xmlEncode($this->getJurisdictionLevel()))
                . ">{$this->xmlEncode($jurisdiction)}</Jurisdiction>"
            : '';
    }

    /**
     * Serialize the tax imposition and type.
     *
     * @return string
     */
    protected function serializeImposition()
    {
        $imposition = $this->getImposition();
        return !is_null($imposition)
            ? '<Imposition'
                . $this->serializeOptionalAttribute('impositionType', $this->xmlEncode($this->getImpositionType()))
                . ">{$this->xmlEncode($imposition)}</Imposition>"
            : '';
    }

    protected function getRootAttributes()
    {
        return [
            'taxType' => $this->getType(),
            'taxability' => $this->getTaxability(),
        ];
    }

    protected function getRootNodeName()
    {
        return static::ROOT_NODE;
    }

    protected function getXmlNamespace()
    {
        return self::XML_NS;
    }
}


1		<?php
2		/**
3		* Copyright (c) 2013-2014 eBay Enterprise, Inc.
4		*
5		* NOTICE OF LICENSE
6		*
7		* This source file is subject to the Open Software License (OSL 3.0)
8		* that is bundled with this package in the file LICENSE.md.
9		* It is also available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* @copyright Copyright (c) 2013-2015 eBay Enterprise, Inc. (http://www.ebayenterprise.com/)
13		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
14		*/
15
16		namespace eBayEnterprise\RetailOrderManagement\Payload\Order;
17
18		use eBayEnterprise\RetailOrderManagement\Payload\IPayload;
19		use eBayEnterprise\RetailOrderManagement\Payload\IPayloadMap;
20		use eBayEnterprise\RetailOrderManagement\Payload\ISchemaValidator;
21		use eBayEnterprise\RetailOrderManagement\Payload\IValidatorIterator;
22		use eBayEnterprise\RetailOrderManagement\Payload\TPayload;
23		use eBayEnterprise\RetailOrderManagement\Payload\TPayloadLogger;
24		use eBayEnterprise\RetailOrderManagement\Payload\Payment\TAmount;
25		use Psr\Log\LoggerInterface;
26		use Psr\Log\NullLogger;
27
28		class Tax implements ITax
29		{
30		use TPayload, TPayloadLogger, TAmount;
31
32		const ROOT_NODE = 'Tax';
33
34		/** @var string */
35		protected $type;
36		/** @var string */
37		protected $taxability;
38		/** @var string */
39		protected $situs;
40		/** @var string */
41		protected $jurisdiction;
42		/** @var string */
43		protected $jurisdictionLevel;
44		/** @var string */
45		protected $jurisdictionId;
46		/** @var string */
47		protected $imposition;
48		/** @var string */
49		protected $impositionType;
50		/** @var float */
51		protected $effectiveRate;
52		/** @var float */
53		protected $taxableAmount;
54		/** @var float */
55		protected $calculatedTax;
56		/** @var string */
57		protected $sellerRegistrationId;
58		/** @var array */
59		protected $allowedTaxTypes = [
60		self::TAX_TYPE_SALES,
61		self::TAX_TYPE_SELLER_USE,
62		self::TAX_TYPE_CONSUMER_USE,
63		self::TAX_TYPE_VAT,
64		self::TAX_TYPE_IMPORT_VAT,
65		self::TAX_TYPE_NONE,
66		];
67		/** @var array */
68		protected $allowedTaxabilities = [
69		self::TAXABILITY_TAXABLE,
70		self::TAXABILITY_NONTAXABLE,
71		self::TAXABILITY_EXEMPT,
72		self::TAXABILITY_DPPAPPLIED,
73		self::TAXABILITY_NO_TAX,
74		self::TAXABILITY_DEFERRED,
75		];
76		/** @var array */
77		protected $allowedSituses = [
78		self::SITUS_ADMINISTRATIVE_DESTINATION,
79		self::SITUS_ADMINISTRATIVE_ORIGIN,
80		self::SITUS_DESTINATION,
81		self::SITUS_PHYSICAL_ORIGIN,
82		];
83		/** @var array */
84		protected $allowedJurisdictionLevels = [
85		self::JURISDICTION_LEVEL_APO,
86		self::JURISDICTION_LEVEL_BOROUGH,
87		self::JURISDICTION_LEVEL_CITY,
88		self::JURISDICTION_LEVEL_COUNTRY,
89		self::JURISDICTION_LEVEL_COUNTY,
90		self::JURISDICTION_LEVEL_DISTRICT,
91		self::JURISDICTION_LEVEL_FPO,
92		self::JURISDICTION_LEVEL_LOCAL_IMPROVEMENT_DISTRICT,
93		self::JURISDICTION_LEVEL_PARISH,
94		self::JURISDICTION_LEVEL_SPECIAL_PURPOSE_DISTRICT,
95		self::JURISDICTION_LEVEL_STATE,
96		self::JURISDICTION_LEVEL_TERRITORY,
97		self::JURISDICTION_LEVEL_TOWNSHIP,
98		self::JURISDICTION_LEVEL_TRADE_BLOCK,
99		self::JURISDICTION_LEVEL_TRANSIT_DISTRICT,
100		self::JURISDICTION_LEVEL_PROVINCE,
101		];
102
103		/**
104		* @param IValidatorIterator
105		* @param ISchemaValidator
106		* @param IPayloadMap
107		* @param LoggerInterface
108		* @param IPayload
109		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
110		*/
111		public function __construct(
112		IValidatorIterator $validators,
113		ISchemaValidator $schemaValidator,
114		IPayloadMap $payloadMap,
115		LoggerInterface $logger,
116		IPayload $parentPayload = null
117		) {
118		$this->logger = $logger;
		0 ignored issues – show Documentation Bug introduced 2015-11-25 17:00 UTC by Report Bug Copy Issue Report It seems like `$logger` of type `object<Psr\Log\LoggerInterface>` is incompatible with the declared type `object<eBayEnterprise\Re...ayload\LoggerInterface>` of property `$logger`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
119		$this->validators = $validators;
120		$this->parentPayload = $parentPayload;
121
122		$this->extractionPaths = [
123		'type' => 'string(@taxType)',
124		'taxability' => 'string(@taxability)',
125		'situs' => 'string(x:Situs)',
126		'effectiveRate' => 'number(x:EffectiveRate)',
127		'calculatedTax' => 'number(x:CalculatedTax)',
128		];
129		$this->optionalExtractionPaths = [
130		'jurisdiction' => 'x:Jurisdiction',
131		'jurisdictionLevel' => 'x:Jurisdiction/@jurisdictionLevel',
132		'jurisdictionId' => 'x:Jurisdiction/@jurisdictionId',
133		'imposition' => 'x:Imposition',
134		'impositionType' => 'x:Imposition/@impositionType',
135		'taxableAmount' => 'x:TaxableAmount',
136		'sellerRegistrationId' => 'x:SellerRegistrationId',
137		];
138		}
139
140		public function getType()
141		{
142		return $this->type;
143		}
144
145		public function setType($type)
146		{
147		$this->type = in_array($type, $this->allowedTaxTypes) ? $type : null;
148		return $this;
149		}
150
151		public function getTaxability()
152		{
153		return $this->taxability;
154		}
155
156		public function setTaxability($taxability)
157		{
158		$this->taxability = in_array($taxability, $this->allowedTaxabilities) ? $taxability : null;
159		return $this;
160		}
161
162		public function getSitus()
163		{
164		return $this->situs;
165		}
166
167		public function setSitus($situs)
168		{
169		$this->situs = in_array($situs, $this->allowedSituses) ? $situs : null;
170		return $this;
171		}
172
173		public function getJurisdiction()
174		{
175		return $this->jurisdiction;
176		}
177
178		public function setJurisdiction($jurisdiction)
179		{
180		$this->jurisdiction = $jurisdiction;
181		return $this;
182		}
183
184		public function getJurisdictionLevel()
185		{
186		return $this->jurisdictionLevel;
187		}
188
189	View Code Duplication	public function setJurisdictionLevel($jurisdictionLevel)
		0 ignored issues – show Duplication introduced 2016-01-11 20:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
190		{
191		$isAllowed = in_array($jurisdictionLevel, $this->allowedJurisdictionLevels);
192		$this->jurisdictionLevel = $isAllowed ? $jurisdictionLevel : null;
193		if (!$isAllowed) {
194		$logData = ['jurisdiction_level' => $jurisdictionLevel];
195		$this->logger->warning(
196		'Jurisdiction Level "{jurisdiction_level}" is not allowed.',
197		$this->getLogContextData(__CLASS__, $logData)
198		);
199		}
200		return $this;
201		}
202		public function getJurisdictionId()
203		{
204		return $this->jurisdictionId;
205		}
206
207		public function setJurisdictionId($jurisdictionId)
208		{
209		$this->jurisdictionId = $jurisdictionId;
210		return $this;
211		}
212
213		public function getImposition()
214		{
215		return $this->imposition;
216		}
217
218		public function setImposition($imposition)
219		{
220		$this->imposition = $imposition;
221		return $this;
222		}
223
224		public function getImpositionType()
225		{
226		return $this->impositionType;
227		}
228
229		public function setImpositionType($impositionType)
230		{
231		$this->impositionType = $this->cleanString($impositionType, 60);
232		return $this;
233		}
234
235		public function getEffectiveRate()
236		{
237		return $this->effectiveRate;
238		}
239
240		public function setEffectiveRate($effectiveRate)
241		{
242		$this->effectiveRate = $effectiveRate;
243		return $this;
244		}
245
246		public function getTaxableAmount()
247		{
248		return $this->taxableAmount;
249		}
250
251		public function setTaxableAmount($taxableAmount)
252		{
253		$this->taxableAmount = $this->sanitizeAmount($taxableAmount);
254		return $this;
255		}
256
257		public function getCalculatedTax()
258		{
259		return $this->calculatedTax;
260		}
261
262		public function setCalculatedTax($calculatedTax)
263		{
264		$this->calculatedTax = $this->sanitizeAmount($calculatedTax);
265		return $this;
266		}
267
268		public function getSellerRegistrationId()
269		{
270		return $this->sellerRegistrationId;
271		}
272
273		public function setSellerRegistrationId($sellerRegistrationId)
274		{
275		$this->sellerRegistrationId = $sellerRegistrationId;
276		return $this;
277		}
278
279		protected function serializeContents()
280		{
281		return "<Situs>{$this->xmlEncode($this->getSitus())}</Situs>"
282		. $this->serializeJurisdiction()
283		. $this->serializeImposition()
284		. $this->serializeEffectiveRate()
285		. $this->serializeOptionalAmount('TaxableAmount', $this->getTaxableAmount())
286		. $this->serializeAmount('CalculatedTax', $this->getCalculatedTax())
287		. $this->serializeOptionalXmlEncodedValue('SellerRegistrationId', $this->getSellerRegistrationId());
288		}
289
290		/**
291		* Serialize the EffectiveRate.
292		* Despite the xsd documentation, this value should not be rounded.
293		*
294		* @return string
295		*/
296		protected function serializeEffectiveRate()
297		{
298		// As a side effect, sprintf will prevent any xml-unsafe value if getEffectiveRate is a string.
299		return sprintf('<EffectiveRate>%F</EffectiveRate>', $this->getEffectiveRate());
300		}
301
302		/**
303		* Serialize the tax jurisdiction, id and level.
304		*
305		* @return string
306		*/
307		protected function serializeJurisdiction()
308		{
309		$jurisdiction = $this->getJurisdiction();
310		return !is_null($jurisdiction)
311		? '<Jurisdiction'
312		. $this->serializeOptionalAttribute('jurisdictionId', $this->xmlEncode($this->getJurisdictionId()))
313		. $this->serializeOptionalAttribute('jurisdictionLevel', $this->xmlEncode($this->getJurisdictionLevel()))
314		. ">{$this->xmlEncode($jurisdiction)}</Jurisdiction>"
315		: '';
316		}
317
318		/**
319		* Serialize the tax imposition and type.
320		*
321		* @return string
322		*/
323		protected function serializeImposition()
324		{
325		$imposition = $this->getImposition();
326		return !is_null($imposition)
327		? '<Imposition'
328		. $this->serializeOptionalAttribute('impositionType', $this->xmlEncode($this->getImpositionType()))
329		. ">{$this->xmlEncode($imposition)}</Imposition>"
330		: '';
331		}
332
333		protected function getRootAttributes()
334		{
335		return [
336		'taxType' => $this->getType(),
337		'taxability' => $this->getTaxability(),
338		];
339		}
340
341		protected function getRootNodeName()
342		{
343		return static::ROOT_NODE;
344		}
345
346		protected function getXmlNamespace()
347		{
348		return self::XML_NS;
349		}
350		}
351

eBayEnterprise / RetailOrderManagement-SDK

GitHub Access Token became invalid

Tax::serializeEffectiveRate() A last analyzed 2016-01-20 19:07 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Tax::serializeEffectiveRate() A
last analyzed 2016-01-20 19:07 UTC