PayPal\StructType\IncentiveDetailsType

Complexity

Total Complexity

34

Size/Duplication

Total Lines	252
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	setUniqueIdentifier()	0	8	3
A	getIncentiveAppliedDetails()	0	3	1
A	getSiteAppliedOn()	0	3	1
A	setIncentiveAppliedDetails()	0	8	2
A	__construct()	0	9	1
A	getErrorCode()	0	3	1
A	getUniqueIdentifier()	0	3	1
A	setTotalDiscountAmount()	0	4	1
B	validateIncentiveAppliedDetailsForArrayConstraintsFromSetIncentiveAppliedDetails()	0	15	7
A	addToIncentiveAppliedDetails()	0	8	4
A	setStatus()	0	8	3
A	setErrorCode()	0	8	4
A	getTotalDiscountAmount()	0	3	1
A	setSiteAppliedOn()	0	8	3
A	getStatus()	0	3	1

<?php

namespace PayPal\StructType;

use \WsdlToPhp\PackageBase\AbstractStructBase;

/**
 * This class stands for IncentiveDetailsType StructType
 * Meta information extracted from the WSDL
 * - documentation: Information about the incentives that were applied from Ebay RYP page and PayPal RYP page.
 * @subpackage Structs
 * @author WsdlToPhp <contact@wsdltophp.com>
 */
class IncentiveDetailsType extends AbstractStructBase
{
    /**
     * The UniqueIdentifier
     * Meta information extracted from the WSDL
     * - documentation: Unique Identifier consisting of redemption code, user friendly descripotion, incentive type, campaign code, incenitve application order and site redeemed on.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $UniqueIdentifier;
    /**
     * The SiteAppliedOn
     * Meta information extracted from the WSDL
     * - documentation: Defines if the incentive has been applied on Ebay or PayPal.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $SiteAppliedOn;
    /**
     * The TotalDiscountAmount
     * Meta information extracted from the WSDL
     * - documentation: The total discount amount for the incentive, summation of discounts up across all the buckets/items.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var \PayPal\StructType\BasicAmountType
     */
    public $TotalDiscountAmount;
    /**
     * The Status
     * Meta information extracted from the WSDL
     * - documentation: Status of incentive processing. Sussess or Error.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var string
     */
    public $Status;
    /**
     * The ErrorCode
     * Meta information extracted from the WSDL
     * - documentation: Error code if there are any errors. Zero otherwise.
     * - maxOccurs: 1
     * - minOccurs: 0
     * @var int
     */
    public $ErrorCode;
    /**
     * The IncentiveAppliedDetails
     * Meta information extracted from the WSDL
     * - documentation: Details of incentive application on individual bucket/item.
     * - maxOccurs: unbounded
     * - minOccurs: 0
     * @var \PayPal\StructType\IncentiveAppliedDetailsType[]
     */
    public $IncentiveAppliedDetails;
    /**
     * Constructor method for IncentiveDetailsType
     * @uses IncentiveDetailsType::setUniqueIdentifier()
     * @uses IncentiveDetailsType::setSiteAppliedOn()
     * @uses IncentiveDetailsType::setTotalDiscountAmount()
     * @uses IncentiveDetailsType::setStatus()
     * @uses IncentiveDetailsType::setErrorCode()
     * @uses IncentiveDetailsType::setIncentiveAppliedDetails()
     * @param string $uniqueIdentifier
     * @param string $siteAppliedOn
     * @param \PayPal\StructType\BasicAmountType $totalDiscountAmount
     * @param string $status
     * @param int $errorCode
     * @param \PayPal\StructType\IncentiveAppliedDetailsType[] $incentiveAppliedDetails
     */
    public function __construct($uniqueIdentifier = null, $siteAppliedOn = null, \PayPal\StructType\BasicAmountType $totalDiscountAmount = null, $status = null, $errorCode = null, array $incentiveAppliedDetails = array())
    {
        $this
            ->setUniqueIdentifier($uniqueIdentifier)
            ->setSiteAppliedOn($siteAppliedOn)
            ->setTotalDiscountAmount($totalDiscountAmount)
            ->setStatus($status)
            ->setErrorCode($errorCode)
            ->setIncentiveAppliedDetails($incentiveAppliedDetails);
    }
    /**
     * Get UniqueIdentifier value
     * @return string|null
     */
    public function getUniqueIdentifier()
    {
        return $this->UniqueIdentifier;
    }
    /**
     * Set UniqueIdentifier value
     * @param string $uniqueIdentifier
     * @return \PayPal\StructType\IncentiveDetailsType
     */
    public function setUniqueIdentifier($uniqueIdentifier = null)
    {
        // validation for constraint: string
        if (!is_null($uniqueIdentifier) && !is_string($uniqueIdentifier)) {

The condition is_string($uniqueIdentifier) is always true.

            throw new \InvalidArgumentException(sprintf('Invalid value %s, please provide a string, %s given', var_export($uniqueIdentifier, true), gettype($uniqueIdentifier)), __LINE__);
        }
        $this->UniqueIdentifier = $uniqueIdentifier;
        return $this;
    }
    /**
     * Get SiteAppliedOn value
     * @return string|null
     */
    public function getSiteAppliedOn()
    {
        return $this->SiteAppliedOn;
    }
    /**
     * Set SiteAppliedOn value
     * @uses \PayPal\EnumType\IncentiveSiteAppliedOnType::valueIsValid()
     * @uses \PayPal\EnumType\IncentiveSiteAppliedOnType::getValidValues()
     * @throws \InvalidArgumentException
     * @param string $siteAppliedOn
     * @return \PayPal\StructType\IncentiveDetailsType
     */
    public function setSiteAppliedOn($siteAppliedOn = null)
    {
        // validation for constraint: enumeration
        if (!\PayPal\EnumType\IncentiveSiteAppliedOnType::valueIsValid($siteAppliedOn)) {
            throw new \InvalidArgumentException(sprintf('Invalid value(s) %s, please use one of: %s from enumeration class \PayPal\EnumType\IncentiveSiteAppliedOnType', is_array($siteAppliedOn) ? implode(', ', $siteAppliedOn) : var_export($siteAppliedOn, true), implode(', ', \PayPal\EnumType\IncentiveSiteAppliedOnType::getValidValues())), __LINE__);

The condition is_array($siteAppliedOn) is always false.

        }
        $this->SiteAppliedOn = $siteAppliedOn;
        return $this;
    }
    /**
     * Get TotalDiscountAmount value
     * @return \PayPal\StructType\BasicAmountType|null
     */
    public function getTotalDiscountAmount()
    {
        return $this->TotalDiscountAmount;
    }
    /**
     * Set TotalDiscountAmount value
     * @param \PayPal\StructType\BasicAmountType $totalDiscountAmount
     * @return \PayPal\StructType\IncentiveDetailsType
     */
    public function setTotalDiscountAmount(\PayPal\StructType\BasicAmountType $totalDiscountAmount = null)
    {
        $this->TotalDiscountAmount = $totalDiscountAmount;
        return $this;
    }
    /**
     * Get Status value
     * @return string|null
     */
    public function getStatus()
    {
        return $this->Status;
    }
    /**
     * Set Status value
     * @uses \PayPal\EnumType\IncentiveAppliedStatusType::valueIsValid()
     * @uses \PayPal\EnumType\IncentiveAppliedStatusType::getValidValues()
     * @throws \InvalidArgumentException
     * @param string $status
     * @return \PayPal\StructType\IncentiveDetailsType
     */
    public function setStatus($status = null)
    {
        // validation for constraint: enumeration
        if (!\PayPal\EnumType\IncentiveAppliedStatusType::valueIsValid($status)) {
            throw new \InvalidArgumentException(sprintf('Invalid value(s) %s, please use one of: %s from enumeration class \PayPal\EnumType\IncentiveAppliedStatusType', is_array($status) ? implode(', ', $status) : var_export($status, true), implode(', ', \PayPal\EnumType\IncentiveAppliedStatusType::getValidValues())), __LINE__);

The condition is_array($status) is always false.

        }
        $this->Status = $status;
        return $this;
    }
    /**
     * Get ErrorCode value
     * @return int|null
     */
    public function getErrorCode()
    {
        return $this->ErrorCode;
    }
    /**
     * Set ErrorCode value
     * @param int $errorCode
     * @return \PayPal\StructType\IncentiveDetailsType
     */
    public function setErrorCode($errorCode = null)
    {
        // validation for constraint: int
        if (!is_null($errorCode) && !(is_int($errorCode) || ctype_digit($errorCode))) {

The condition is_int($errorCode) is always true.

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

The condition is_array($invalidValues) is always true.

The condition is_object($invalidValues) is always false.

        }
        unset($invalidValues);
        return $message;
    }
    /**
     * Set IncentiveAppliedDetails value
     * @throws \InvalidArgumentException
     * @param \PayPal\StructType\IncentiveAppliedDetailsType[] $incentiveAppliedDetails
     * @return \PayPal\StructType\IncentiveDetailsType
     */
    public function setIncentiveAppliedDetails(array $incentiveAppliedDetails = array())
    {
        // validation for constraint: array
        if ('' !== ($incentiveAppliedDetailsArrayErrorMessage = self::validateIncentiveAppliedDetailsForArrayConstraintsFromSetIncentiveAppliedDetails($incentiveAppliedDetails))) {
            throw new \InvalidArgumentException($incentiveAppliedDetailsArrayErrorMessage, __LINE__);
        }
        $this->IncentiveAppliedDetails = $incentiveAppliedDetails;
        return $this;
    }
    /**
     * Add item to IncentiveAppliedDetails value
     * @throws \InvalidArgumentException
     * @param \PayPal\StructType\IncentiveAppliedDetailsType $item
     * @return \PayPal\StructType\IncentiveDetailsType
     */
    public function addToIncentiveAppliedDetails(\PayPal\StructType\IncentiveAppliedDetailsType $item)
    {
        // validation for constraint: itemType
        if (!$item instanceof \PayPal\StructType\IncentiveAppliedDetailsType) {

$item is always a sub-type of PayPal\StructType\IncentiveAppliedDetailsType.

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