eBayEnterprise\RetailOrderManagement\Payload\OrderEvents\OrderCreditIssued

Complexity

Total Complexity

8

Size/Duplication

Total Lines	106
Duplicated Lines	9.43 %

Coupling/Cohesion

Components	2
Dependencies	8

Importance

Changes	4
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getEventType()	0	4	1
A	getSchemaFile()	0	4	1
A	getXmlNamespace()	0	4	1
A	getRootNodeName()	0	4	1
B	__construct()	0	44	1
A	getRootAttributes()	10	10	1
A	serializeContents()	0	6	1
A	serializeOrderSummary()	0	10	1

<?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-2014 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\OrderEvents;

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

class OrderCreditIssued implements IOrderCreditIssued
{
    use TTopLevelPayload, TOrderEvent, TCurrency, TLoyaltyProgramCustomer, TOrderItemContainer, TReturnSummary, TAmount;

    /**
     * @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;

It seems like $logger of type object<Psr\Log\LoggerInterface> is incompatible with the declared type object<eBayEnterprise\RetailOrderManagement\Payload\LoggerInterface> of property $logger.

        $this->validators = $validators;
        $this->schemaValidator = $schemaValidator;
        $this->payloadMap = $payloadMap;
        $this->parentPayload = $parentPayload;
        $this->payloadFactory = new PayloadFactory();

        $this->loyaltyPrograms =
            $this->buildPayloadForInterface(static::LOYALTY_PROGRAM_ITERABLE_INTERFACE);
        $this->orderItems =
            $this->buildPayloadForInterface(static::ORDER_ITEM_ITERABLE_INTERFACE);

        $this->extractionPaths = [
            'storeId' => 'string(@storeId)',
            'currencyCode' => 'string(@currency)',
            'currencySymbol' => 'string(@currencySymbol)',
            'customerFirstName' => 'string(x:Customer/x:Name/x:FirstName)',
            'customerLastName' => 'string(x:Customer/x:Name/x:LastName)',
            'customerEmailAddress' => 'string(x:Customer/x:Name/x:EmailAddress)',
            'orderId' => 'string(@customerOrderId)',
            'returnOrCredit' => 'string(x:CreditIssuedSummary/@returnOrCreditIssued)',
            'referenceNumber' => 'string(x:CreditIssuedSummary/@creditRefNumber)',
            'totalCredit' => 'string(x:CreditIssuedSummary/@totalCredit)'
        ];

        $this->optionalExtractionPaths = [
            'customerId' => 'x:Customer/@customerId',
            'customerMiddleName' => 'x:Customer/x:Name/x:MiddleName',
            'customerHonorificName' => 'x:Customer/x:Name/x:Honorific',
            'customerEmailAddress' => 'x:Customer/x:EmailAddress'
        ];

        $this->subpayloadExtractionPaths = [
            'loyaltyPrograms' => 'x:Customer/x:LoyaltyPrograms',
            'orderItems' => 'x:AdjustedOrderItems'
        ];
    }

    protected function getRootAttributes()

This method seems to be duplicated in your project.

    {
        return [
            'xmlns' => $this->getXmlNamespace(),
            'customerOrderId' => $this->getCustomerOrderId(),
            'storeId' => $this->getStoreId(),
            'currency' => $this->getCurrencyCode(),
            'currencySymbol' => $this->getCurrencySymbol()
        ];
    }

    public function getEventType()
    {
        return static::ROOT_NODE;
    }

    protected function getSchemaFile()
    {
        return $this->getSchemaDir() . self::XSD;
    }

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

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

    protected function serializeContents()
    {
        return $this->serializeCustomer()
            . $this->getOrderItems()->serialize()
            . $this->serializeOrderSummary();
    }

    protected function serializeOrderSummary()
    {
        $format = '<CreditIssuedSummary returnOrCreditIssued="%s" creditRefNumber="%s" totalCredit="%s"></CreditIssuedSummary>';
        return sprintf(
            $format,
            $this->getReturnOrCredit(),
            $this->getReferenceNumber(),
            $this->formatAmount($this->getTotalCredit())
        );
    }
}