PayPal\StructType\PaymentTransactionType

Complexity

Total Complexity

55

Size/Duplication

Total Lines	515
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	getTPLReferenceID()	0	3	1
A	setTPLReferenceID()	0	8	3
A	setGiftMessage()	0	8	3
A	getUserSelectedOptions()	0	3	1
A	getGiftMessage()	0	3	1
A	setReceiverInfo()	0	4	1
A	getSurveyQuestion()	0	3	1
A	__construct()	0	18	1
A	setSurveyChoiceSelected()	0	8	2
A	setPayerInfo()	0	4	1
A	getSurveyChoiceSelected()	0	3	1
A	setPaymentInfo()	0	4	1
A	setGiftWrapAmount()	0	4	1
A	getOfferCouponInfo()	0	3	1
A	setGiftWrapName()	0	8	3
B	validateSurveyChoiceSelectedForArrayConstraintsFromSetSurveyChoiceSelected()	0	15	7
A	setSurveyQuestion()	0	8	3
A	setBuyerEmailOptIn()	0	8	3
A	getPaymentInfo()	0	3	1
A	getPayerInfo()	0	3	1
A	getGiftWrapAmount()	0	3	1
A	getGiftReceipt()	0	3	1
A	setUserSelectedOptions()	0	4	1
A	getGiftWrapName()	0	3	1
A	getPaymentItemInfo()	0	3	1
A	getReceiverInfo()	0	3	1
A	setSecondaryAddress()	0	4	1
A	setPaymentItemInfo()	0	4	1
A	getSecondaryAddress()	0	3	1
A	setOfferCouponInfo()	0	4	1
A	addToSurveyChoiceSelected()	0	8	4
A	setGiftReceipt()	0	8	3
A	getBuyerEmailOptIn()	0	3	1

<?php

namespace PayPal\StructType;

use \WsdlToPhp\PackageBase\AbstractStructBase;

/**
 * This class stands for PaymentTransactionType StructType
 * Meta information extracted from the WSDL
 * - documentation: PaymentTransactionType Information about a PayPal payment from the seller side
 * @subpackage Structs
 * @author WsdlToPhp <contact@wsdltophp.com>
 */
class PaymentTransactionType extends AbstractStructBase
{
    /**
     * The ReceiverInfo
     * Meta information extracted from the WSDL
     * - documentation: Information about the recipient of the payment
     * @var \PayPal\StructType\ReceiverInfoType
     */
    public $ReceiverInfo;
    /**
     * The PayerInfo
     * Meta information extracted from the WSDL
     * - documentation: Information about the payer
     * @var \PayPal\StructType\PayerInfoType
     */
    public $PayerInfo;
    /**
     * The TPLReferenceID
     * Meta information extracted from the WSDL
     * - documentation: This field is for holding ReferenceId for shippment sent from Merchant to the 3rd Party
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $TPLReferenceID;
    /**
     * The PaymentInfo
     * Meta information extracted from the WSDL
     * - documentation: Information about the transaction
     * @var \PayPal\StructType\PaymentInfoType
     */
    public $PaymentInfo;
    /**
     * The PaymentItemInfo
     * Meta information extracted from the WSDL
     * - documentation: Information about an individual item in the transaction
     * - minOccurs: 0
     * @var \PayPal\StructType\PaymentItemInfoType
     */
    public $PaymentItemInfo;
    /**
     * The OfferCouponInfo
     * Meta information extracted from the WSDL
     * - documentation: Information about an individual Offer and Coupon information in the transaction
     * - minOccurs: 0
     * @var \PayPal\StructType\OfferCouponInfoType
     */
    public $OfferCouponInfo;
    /**
     * The SecondaryAddress
     * Meta information extracted from the WSDL
     * - documentation: Information about Secondary Address
     * - minOccurs: 0
     * @var \PayPal\StructType\AddressType
     */
    public $SecondaryAddress;
    /**
     * The UserSelectedOptions
     * Meta information extracted from the WSDL
     * - documentation: Information about the user selected options.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var \PayPal\StructType\UserSelectedOptionType
     */
    public $UserSelectedOptions;
    /**
     * The GiftMessage
     * Meta information extracted from the WSDL
     * - documentation: Information about the Gift message.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $GiftMessage;
    /**
     * The GiftReceipt
     * Meta information extracted from the WSDL
     * - documentation: Information about the Gift receipt.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $GiftReceipt;
    /**
     * The GiftWrapName
     * Meta information extracted from the WSDL
     * - documentation: Information about the Gift Wrap name.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $GiftWrapName;
    /**
     * The GiftWrapAmount
     * Meta information extracted from the WSDL
     * - documentation: Information about the Gift Wrap amount.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var \PayPal\StructType\BasicAmountType
     */
    public $GiftWrapAmount;
    /**
     * The BuyerEmailOptIn
     * Meta information extracted from the WSDL
     * - documentation: Information about the Buyer email.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $BuyerEmailOptIn;
    /**
     * The SurveyQuestion
     * Meta information extracted from the WSDL
     * - documentation: Information about the survey question.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $SurveyQuestion;
    /**
     * The SurveyChoiceSelected
     * Meta information extracted from the WSDL
     * - documentation: Information about the survey choice selected by the user.
     * - maxOccurs: unbounded
     * - minOccurs: 0
     * @var string[]
     */
    public $SurveyChoiceSelected;
    /**
     * Constructor method for PaymentTransactionType
     * @uses PaymentTransactionType::setReceiverInfo()
     * @uses PaymentTransactionType::setPayerInfo()
     * @uses PaymentTransactionType::setTPLReferenceID()
     * @uses PaymentTransactionType::setPaymentInfo()
     * @uses PaymentTransactionType::setPaymentItemInfo()
     * @uses PaymentTransactionType::setOfferCouponInfo()
     * @uses PaymentTransactionType::setSecondaryAddress()
     * @uses PaymentTransactionType::setUserSelectedOptions()
     * @uses PaymentTransactionType::setGiftMessage()
     * @uses PaymentTransactionType::setGiftReceipt()
     * @uses PaymentTransactionType::setGiftWrapName()
     * @uses PaymentTransactionType::setGiftWrapAmount()
     * @uses PaymentTransactionType::setBuyerEmailOptIn()
     * @uses PaymentTransactionType::setSurveyQuestion()
     * @uses PaymentTransactionType::setSurveyChoiceSelected()
     * @param \PayPal\StructType\ReceiverInfoType $receiverInfo
     * @param \PayPal\StructType\PayerInfoType $payerInfo
     * @param string $tPLReferenceID
     * @param \PayPal\StructType\PaymentInfoType $paymentInfo
     * @param \PayPal\StructType\PaymentItemInfoType $paymentItemInfo
     * @param \PayPal\StructType\OfferCouponInfoType $offerCouponInfo
     * @param \PayPal\StructType\AddressType $secondaryAddress
     * @param \PayPal\StructType\UserSelectedOptionType $userSelectedOptions
     * @param string $giftMessage
     * @param string $giftReceipt
     * @param string $giftWrapName
     * @param \PayPal\StructType\BasicAmountType $giftWrapAmount
     * @param string $buyerEmailOptIn
     * @param string $surveyQuestion
     * @param string[] $surveyChoiceSelected
     */
    public function __construct(\PayPal\StructType\ReceiverInfoType $receiverInfo = null, \PayPal\StructType\PayerInfoType $payerInfo = null, $tPLReferenceID = null, \PayPal\StructType\PaymentInfoType $paymentInfo = null, \PayPal\StructType\PaymentItemInfoType $paymentItemInfo = null, \PayPal\StructType\OfferCouponInfoType $offerCouponInfo = null, \PayPal\StructType\AddressType $secondaryAddress = null, \PayPal\StructType\UserSelectedOptionType $userSelectedOptions = null, $giftMessage = null, $giftReceipt = null, $giftWrapName = null, \PayPal\StructType\BasicAmountType $giftWrapAmount = null, $buyerEmailOptIn = null, $surveyQuestion = null, array $surveyChoiceSelected = array())
    {
        $this
            ->setReceiverInfo($receiverInfo)
            ->setPayerInfo($payerInfo)
            ->setTPLReferenceID($tPLReferenceID)
            ->setPaymentInfo($paymentInfo)
            ->setPaymentItemInfo($paymentItemInfo)
            ->setOfferCouponInfo($offerCouponInfo)
            ->setSecondaryAddress($secondaryAddress)
            ->setUserSelectedOptions($userSelectedOptions)
            ->setGiftMessage($giftMessage)
            ->setGiftReceipt($giftReceipt)
            ->setGiftWrapName($giftWrapName)
            ->setGiftWrapAmount($giftWrapAmount)
            ->setBuyerEmailOptIn($buyerEmailOptIn)
            ->setSurveyQuestion($surveyQuestion)
            ->setSurveyChoiceSelected($surveyChoiceSelected);
    }
    /**
     * Get ReceiverInfo value
     * @return \PayPal\StructType\ReceiverInfoType|null
     */
    public function getReceiverInfo()
    {
        return $this->ReceiverInfo;
    }
    /**
     * Set ReceiverInfo value
     * @param \PayPal\StructType\ReceiverInfoType $receiverInfo
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setReceiverInfo(\PayPal\StructType\ReceiverInfoType $receiverInfo = null)
    {
        $this->ReceiverInfo = $receiverInfo;
        return $this;
    }
    /**
     * Get PayerInfo value
     * @return \PayPal\StructType\PayerInfoType|null
     */
    public function getPayerInfo()
    {
        return $this->PayerInfo;
    }
    /**
     * Set PayerInfo value
     * @param \PayPal\StructType\PayerInfoType $payerInfo
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setPayerInfo(\PayPal\StructType\PayerInfoType $payerInfo = null)
    {
        $this->PayerInfo = $payerInfo;
        return $this;
    }
    /**
     * Get TPLReferenceID value
     * @return string|null
     */
    public function getTPLReferenceID()
    {
        return $this->TPLReferenceID;
    }
    /**
     * Set TPLReferenceID value
     * @param string $tPLReferenceID
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setTPLReferenceID($tPLReferenceID = null)
    {
        // validation for constraint: string
        if (!is_null($tPLReferenceID) && !is_string($tPLReferenceID)) {

The condition is_string($tPLReferenceID) is always true.

            throw new \InvalidArgumentException(sprintf('Invalid value %s, please provide a string, %s given', var_export($tPLReferenceID, true), gettype($tPLReferenceID)), __LINE__);
        }
        $this->TPLReferenceID = $tPLReferenceID;
        return $this;
    }
    /**
     * Get PaymentInfo value
     * @return \PayPal\StructType\PaymentInfoType|null
     */
    public function getPaymentInfo()
    {
        return $this->PaymentInfo;
    }
    /**
     * Set PaymentInfo value
     * @param \PayPal\StructType\PaymentInfoType $paymentInfo
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setPaymentInfo(\PayPal\StructType\PaymentInfoType $paymentInfo = null)
    {
        $this->PaymentInfo = $paymentInfo;
        return $this;
    }
    /**
     * Get PaymentItemInfo value
     * @return \PayPal\StructType\PaymentItemInfoType|null
     */
    public function getPaymentItemInfo()
    {
        return $this->PaymentItemInfo;
    }
    /**
     * Set PaymentItemInfo value
     * @param \PayPal\StructType\PaymentItemInfoType $paymentItemInfo
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setPaymentItemInfo(\PayPal\StructType\PaymentItemInfoType $paymentItemInfo = null)
    {
        $this->PaymentItemInfo = $paymentItemInfo;
        return $this;
    }
    /**
     * Get OfferCouponInfo value
     * @return \PayPal\StructType\OfferCouponInfoType|null
     */
    public function getOfferCouponInfo()
    {
        return $this->OfferCouponInfo;
    }
    /**
     * Set OfferCouponInfo value
     * @param \PayPal\StructType\OfferCouponInfoType $offerCouponInfo
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setOfferCouponInfo(\PayPal\StructType\OfferCouponInfoType $offerCouponInfo = null)
    {
        $this->OfferCouponInfo = $offerCouponInfo;
        return $this;
    }
    /**
     * Get SecondaryAddress value
     * @return \PayPal\StructType\AddressType|null
     */
    public function getSecondaryAddress()
    {
        return $this->SecondaryAddress;
    }
    /**
     * Set SecondaryAddress value
     * @param \PayPal\StructType\AddressType $secondaryAddress
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setSecondaryAddress(\PayPal\StructType\AddressType $secondaryAddress = null)
    {
        $this->SecondaryAddress = $secondaryAddress;
        return $this;
    }
    /**
     * Get UserSelectedOptions value
     * @return \PayPal\StructType\UserSelectedOptionType|null
     */
    public function getUserSelectedOptions()
    {
        return $this->UserSelectedOptions;
    }
    /**
     * Set UserSelectedOptions value
     * @param \PayPal\StructType\UserSelectedOptionType $userSelectedOptions
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setUserSelectedOptions(\PayPal\StructType\UserSelectedOptionType $userSelectedOptions = null)
    {
        $this->UserSelectedOptions = $userSelectedOptions;
        return $this;
    }
    /**
     * Get GiftMessage value
     * @return string|null
     */
    public function getGiftMessage()
    {
        return $this->GiftMessage;
    }
    /**
     * Set GiftMessage value
     * @param string $giftMessage
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setGiftMessage($giftMessage = null)
    {
        // validation for constraint: string
        if (!is_null($giftMessage) && !is_string($giftMessage)) {

The condition is_string($giftMessage) is always true.

            throw new \InvalidArgumentException(sprintf('Invalid value %s, please provide a string, %s given', var_export($giftMessage, true), gettype($giftMessage)), __LINE__);
        }
        $this->GiftMessage = $giftMessage;
        return $this;
    }
    /**
     * Get GiftReceipt value
     * @return string|null
     */
    public function getGiftReceipt()
    {
        return $this->GiftReceipt;
    }
    /**
     * Set GiftReceipt value
     * @param string $giftReceipt
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setGiftReceipt($giftReceipt = null)
    {
        // validation for constraint: string
        if (!is_null($giftReceipt) && !is_string($giftReceipt)) {

The condition is_string($giftReceipt) is always true.

            throw new \InvalidArgumentException(sprintf('Invalid value %s, please provide a string, %s given', var_export($giftReceipt, true), gettype($giftReceipt)), __LINE__);
        }
        $this->GiftReceipt = $giftReceipt;
        return $this;
    }
    /**
     * Get GiftWrapName value
     * @return string|null
     */
    public function getGiftWrapName()
    {
        return $this->GiftWrapName;
    }
    /**
     * Set GiftWrapName value
     * @param string $giftWrapName
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setGiftWrapName($giftWrapName = null)
    {
        // validation for constraint: string
        if (!is_null($giftWrapName) && !is_string($giftWrapName)) {

The condition is_string($giftWrapName) is always true.

            throw new \InvalidArgumentException(sprintf('Invalid value %s, please provide a string, %s given', var_export($giftWrapName, true), gettype($giftWrapName)), __LINE__);
        }
        $this->GiftWrapName = $giftWrapName;
        return $this;
    }
    /**
     * Get GiftWrapAmount value
     * @return \PayPal\StructType\BasicAmountType|null
     */
    public function getGiftWrapAmount()
    {
        return $this->GiftWrapAmount;
    }
    /**
     * Set GiftWrapAmount value
     * @param \PayPal\StructType\BasicAmountType $giftWrapAmount
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setGiftWrapAmount(\PayPal\StructType\BasicAmountType $giftWrapAmount = null)
    {
        $this->GiftWrapAmount = $giftWrapAmount;
        return $this;
    }
    /**
     * Get BuyerEmailOptIn value
     * @return string|null
     */
    public function getBuyerEmailOptIn()
    {
        return $this->BuyerEmailOptIn;
    }
    /**
     * Set BuyerEmailOptIn value
     * @param string $buyerEmailOptIn
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setBuyerEmailOptIn($buyerEmailOptIn = null)
    {
        // validation for constraint: string
        if (!is_null($buyerEmailOptIn) && !is_string($buyerEmailOptIn)) {

The condition is_string($buyerEmailOptIn) is always true.

            throw new \InvalidArgumentException(sprintf('Invalid value %s, please provide a string, %s given', var_export($buyerEmailOptIn, true), gettype($buyerEmailOptIn)), __LINE__);
        }
        $this->BuyerEmailOptIn = $buyerEmailOptIn;
        return $this;
    }
    /**
     * Get SurveyQuestion value
     * @return string|null
     */
    public function getSurveyQuestion()
    {
        return $this->SurveyQuestion;
    }
    /**
     * Set SurveyQuestion value
     * @param string $surveyQuestion
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setSurveyQuestion($surveyQuestion = null)
    {
        // validation for constraint: string
        if (!is_null($surveyQuestion) && !is_string($surveyQuestion)) {

The condition is_string($surveyQuestion) is always true.

            throw new \InvalidArgumentException(sprintf('Invalid value %s, please provide a string, %s given', var_export($surveyQuestion, true), gettype($surveyQuestion)), __LINE__);
        }
        $this->SurveyQuestion = $surveyQuestion;
        return $this;
    }
    /**
     * Get SurveyChoiceSelected value
     * @return string[]|null
     */
    public function getSurveyChoiceSelected()
    {
        return $this->SurveyChoiceSelected;
    }
    /**
     * This method is responsible for validating the values passed to the setSurveyChoiceSelected method
     * This method is willingly generated in order to preserve the one-line inline validation within the setSurveyChoiceSelected method
     * @param array $values
     * @return string A non-empty message if the values does not match the validation rules
     */
    public static function validateSurveyChoiceSelectedForArrayConstraintsFromSetSurveyChoiceSelected(array $values = array())
    {
        $message = '';
        $invalidValues = [];
        foreach ($values as $paymentTransactionTypeSurveyChoiceSelectedItem) {
            // validation for constraint: itemType
            if (!is_string($paymentTransactionTypeSurveyChoiceSelectedItem)) {
                $invalidValues[] = is_object($paymentTransactionTypeSurveyChoiceSelectedItem) ? get_class($paymentTransactionTypeSurveyChoiceSelectedItem) : sprintf('%s(%s)', gettype($paymentTransactionTypeSurveyChoiceSelectedItem), var_export($paymentTransactionTypeSurveyChoiceSelectedItem, true));
            }
        }
        if (!empty($invalidValues)) {
            $message = sprintf('The SurveyChoiceSelected property can only contain items of type string, %s given', is_object($invalidValues) ? get_class($invalidValues) : (is_array($invalidValues) ? implode(', ', $invalidValues) : gettype($invalidValues)));

The condition is_object($invalidValues) is always false.

The condition is_array($invalidValues) is always true.

        }
        unset($invalidValues);
        return $message;
    }
    /**
     * Set SurveyChoiceSelected value
     * @throws \InvalidArgumentException
     * @param string[] $surveyChoiceSelected
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function setSurveyChoiceSelected(array $surveyChoiceSelected = array())
    {
        // validation for constraint: array
        if ('' !== ($surveyChoiceSelectedArrayErrorMessage = self::validateSurveyChoiceSelectedForArrayConstraintsFromSetSurveyChoiceSelected($surveyChoiceSelected))) {
            throw new \InvalidArgumentException($surveyChoiceSelectedArrayErrorMessage, __LINE__);
        }
        $this->SurveyChoiceSelected = $surveyChoiceSelected;
        return $this;
    }
    /**
     * Add item to SurveyChoiceSelected value
     * @throws \InvalidArgumentException
     * @param string $item
     * @return \PayPal\StructType\PaymentTransactionType
     */
    public function addToSurveyChoiceSelected($item)
    {
        // validation for constraint: itemType
        if (!is_string($item)) {

The condition is_string($item) is always true.

            throw new \InvalidArgumentException(sprintf('The SurveyChoiceSelected property can only contain items of type string, %s given', is_object($item) ? get_class($item) : (is_array($item) ? implode(', ', $item) : gettype($item))), __LINE__);
        }
        $this->SurveyChoiceSelected[] = $item;
        return $this;
    }
}