PaymentDraft::setExternalId() - Code Metrics - Inspection of "Payment extension integration test refactor (#533)" - commercetools/commercetools-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop ( fbd41a...181ca2 )

by Jens
created 2020-01-22 09:50 UTC
PaymentDraft::setExternalId() A

↳ Parent: PaymentDraft
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	1
crap	1
<?php
/**
 * @author @jenschude <[email protected]>
 */

namespace Commercetools\Core\Model\Payment;

use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\JsonObject;
use Commercetools\Core\Model\Customer\CustomerReference;
use Commercetools\Core\Model\Common\Money;
use Commercetools\Core\Model\Common\DateTimeDecorator;
use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
use Commercetools\Core\Model\CustomField\CustomFieldObjectDraftCollection;
use DateTime;

/**
 * @package Commercetools\Core\Model\Payment
 * @link https://docs.commercetools.com/http-api-projects-payments.html#paymentdraft
 * @method CustomerReference getCustomer()
 * @method PaymentDraft setCustomer(CustomerReference $customer = null)
 * @method string getInterfaceId()
 * @method PaymentDraft setInterfaceId(string $interfaceId = null)
 * @method Money getAmountPlanned()
 * @method PaymentDraft setAmountPlanned(Money $amountPlanned = null)
 * @method PaymentMethodInfo getPaymentMethodInfo()
 * @method PaymentDraft setPaymentMethodInfo(PaymentMethodInfo $paymentMethodInfo = null)
 * @method CustomFieldObjectDraft getCustom()
 * @method PaymentDraft setCustom(CustomFieldObjectDraft $custom = null)
 * @method PaymentStatus getPaymentStatus()
 * @method PaymentDraft setPaymentStatus(PaymentStatus $paymentStatus = null)
 * @method TransactionCollection getTransactions()
 * @method PaymentDraft setTransactions(TransactionCollection $transactions = null)
 * @method CustomFieldObjectDraftCollection getInterfaceInteractions()
 * @method PaymentDraft setInterfaceInteractions(CustomFieldObjectDraftCollection $interfaceInteractions = null)
 * @method string getKey()
 * @method PaymentDraft setKey(string $key = null)
 * @method string getAnonymousId()
 * @method PaymentDraft setAnonymousId(string $anonymousId = null)
 */
class PaymentDraft extends JsonObject
{
    public function fieldDefinitions()
    {
        return [
            'key' => [static::TYPE => 'string'],
            'customer' => [static::TYPE => CustomerReference::class],
            'anonymousId' => [static::TYPE => 'string'],
            'externalId' => [static::TYPE => 'string'],
            'interfaceId' => [static::TYPE => 'string'],
            'amountPlanned' => [static::TYPE => Money::class],
            'amountAuthorized' => [static::TYPE => Money::class],
            'authorizedUntil' => [
                static::TYPE => DateTime::class,
                static::DECORATOR => DateTimeDecorator::class
            ],
            'amountPaid' => [static::TYPE => Money::class],
            'amountRefunded' => [static::TYPE => Money::class],
            'paymentMethodInfo' => [static::TYPE => PaymentMethodInfo::class],
            'custom' => [static::TYPE => CustomFieldObjectDraft::class],
            'paymentStatus' => [static::TYPE => PaymentStatus::class],
            'transactions' => [static::TYPE => TransactionCollection::class],
            'interfaceInteractions' => [
                static::TYPE => CustomFieldObjectDraftCollection::class
            ],
        ];
    }

    /**
     * @deprecated
     * @return string
     */
    public function getExternalId()
    {
        return parent::getExternalId();
        return parent::/** @scrutinizer ignore-call */ getExternalId();
    }

    /**
     * @deprecated use setKey() instead
     * @param string $externalId
     * @return static
     */
    public function setExternalId($externalId = null)
    {
        return parent::setExternalId($externalId);
        return parent::/** @scrutinizer ignore-call */ setExternalId($externalId);
    }

    /**
     * @deprecated
     * @return Money
     */
    public function getAmountAuthorized()
    {
        return parent::getAmountAuthorized();
        return parent::/** @scrutinizer ignore-call */ getAmountAuthorized();
    }

    /**
     * @deprecated
     * @param Money $amountAuthorized
     * @return static
     */
    public function setAmountAuthorized(Money $amountAuthorized = null)
    {
        return parent::setAmountAuthorized($amountAuthorized);
        return parent::/** @scrutinizer ignore-call */ setAmountAuthorized($amountAuthorized);
    }

    /**
     * @deprecated
     * @return Money
     */
    public function getAmountPaid()
    {
        return parent::getAmountPaid();
        return parent::/** @scrutinizer ignore-call */ getAmountPaid();
    }

    /**
     * @deprecated
     * @param Money $amountPaid
     * @return static
     */
    public function setAmountPaid(Money $amountPaid = null)
    {
        return parent::setAmountPaid($amountPaid);
        return parent::/** @scrutinizer ignore-call */ setAmountPaid($amountPaid);
    }

    /**
     * @deprecated
     * @return Money
     */
    public function getAmountRefunded()
    {
        return parent::getAmountRefunded();
        return parent::/** @scrutinizer ignore-call */ getAmountRefunded();
    }

    /**
     * @deprecated
     * @param Money $amountRefunded
     * @return static
     */
    public function setAmountRefunded(Money $amountRefunded = null)
    {
        return parent::setAmountRefunded($amountRefunded);
        return parent::/** @scrutinizer ignore-call */ setAmountRefunded($amountRefunded);
    }

    /**
     * @deprecated
     * @return Money
     */
    public function getAuthorizedUntil()
    {
        return parent::getAuthorizedUntil();
        return parent::/** @scrutinizer ignore-call */ getAuthorizedUntil();
    }

    /**
     * @deprecated
     * @param Money $amountUntil
     * @return static
     */
    public function setAuthorizedUntil(Money $amountUntil = null)
    {
        return parent::setAuthorizedUntil($amountUntil);
        return parent::/** @scrutinizer ignore-call */ setAuthorizedUntil($amountUntil);
    }

    /**
     * @param Money $amountPlanned
     * @param Context|callable $context
     * @return PaymentDraft
     */
    public static function ofAmountPlanned(Money $amountPlanned, $context = null)
    {
        return static::of($context)->setAmountPlanned($amountPlanned);
    }

    /**
     * @param string $key
     * @param string $externalId
     * @param Money $amountPlanned
     * @param Context|callable $context
     * @return PaymentDraft
     */
    public static function ofKeyExternalIdAndAmountPlanned($key, $externalId, Money $amountPlanned, $context = null)
    {
        return static::of($context)->setKey($key)->setExternalId($externalId)->setAmountPlanned($amountPlanned);
        return /** @scrutinizer ignore-deprecated */ static::of($context)->setKey($key)->setExternalId($externalId)->setAmountPlanned($amountPlanned);
    }

    /**
     * @param string $key
     * @param string $externalId
     * @param Money $amountPlanned
     * @param PaymentMethodInfo $paymentMethodInfo
     * @param Context|callable $context
     * @return PaymentDraft
     */
    public static function ofKeyExternalIdAmountPlannedAndPaymentMethodInfo(
        $key,
        $externalId,
        Money $amountPlanned,
        PaymentMethodInfo $paymentMethodInfo,
        $context = null
    ) {
        return static::of($context)
        return /** @scrutinizer ignore-deprecated */ static::of($context)
            ->setKey($key)
            ->setExternalId($externalId)
            ->setAmountPlanned($amountPlanned)
            ->setPaymentMethodInfo($paymentMethodInfo);
    }
}

commercetools / commercetools-php-sdk

Push — develop ( fbd41a...181ca2 )

PaymentDraft::setExternalId() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
