<?php

namespace patest\ArrayType;

use \WsdlToPhp\PackageBase\AbstractStructArrayBase;

/**
 * This class stands for ArrayOfRefundOptionDescription ArrayType
 * Meta information extracted from the WSDL
 * - nillable: true
 * - type: tns:ArrayOfRefundOptionDescription
 * @subpackage Arrays
 */
class ArrayOfRefundOptionDescription extends AbstractStructArrayBase
{
    /**
     * The RefundOptionDescription
     * Meta information extracted from the WSDL
     * - maxOccurs: unbounded
     * - minOccurs: 0
     * - nillable: true
     * @var \patest\StructType\RefundOptionDescription[]
     */
    public $RefundOptionDescription;
    /**
     * Constructor method for ArrayOfRefundOptionDescription
     * @uses ArrayOfRefundOptionDescription::setRefundOptionDescription()
     * @param \patest\StructType\RefundOptionDescription[] $refundOptionDescription
     */
    public function __construct(array $refundOptionDescription = array())
    {
        $this
            ->setRefundOptionDescription($refundOptionDescription);
    }
    /**
     * Get RefundOptionDescription value
     * An additional test has been added (isset) before returning the property value as
     * this property may have been unset before, due to the fact that this property is
     * removable from the request (nillable=true+minOccurs=0)
     * @return \patest\StructType\RefundOptionDescription[]|null
     */
    public function getRefundOptionDescription()
    {
        return isset($this->RefundOptionDescription) ? $this->RefundOptionDescription : null;
    }
    /**
     * This method is responsible for validating the values passed to the setRefundOptionDescription method
     * This method is willingly generated in order to preserve the one-line inline validation within the setRefundOptionDescription method
     * @param array $values
     * @return string A non-empty message if the values does not match the validation rules
     */
    public static function validateRefundOptionDescriptionForArrayConstraintsFromSetRefundOptionDescription(array $values = array())
    {
        $message = '';
        $invalidValues = [];
        foreach ($values as $arrayOfRefundOptionDescriptionRefundOptionDescriptionItem) {
            // validation for constraint: itemType
            if (!$arrayOfRefundOptionDescriptionRefundOptionDescriptionItem instanceof \patest\StructType\RefundOptionDescription) {
                $invalidValues[] = is_object($arrayOfRefundOptionDescriptionRefundOptionDescriptionItem) ? get_class($arrayOfRefundOptionDescriptionRefundOptionDescriptionItem) : sprintf('%s(%s)', gettype($arrayOfRefundOptionDescriptionRefundOptionDescriptionItem), var_export($arrayOfRefundOptionDescriptionRefundOptionDescriptionItem, true));
            }
        }
        if (!empty($invalidValues)) {
            $message = sprintf('The RefundOptionDescription property can only contain items of type \patest\StructType\RefundOptionDescription, %s given', is_object($invalidValues) ? get_class($invalidValues) : (is_array($invalidValues) ? implode(', ', $invalidValues) : gettype($invalidValues)));
        }
        unset($invalidValues);
        return $message;
    }
    /**
     * Set RefundOptionDescription value
     * This property is removable from request (nillable=true+minOccurs=0), therefore
     * if the value assigned to this property is null, it is removed from this object
     * @throws \InvalidArgumentException
     * @param \patest\StructType\RefundOptionDescription[] $refundOptionDescription
     * @return \patest\ArrayType\ArrayOfRefundOptionDescription
     */
    public function setRefundOptionDescription(array $refundOptionDescription = array())
    {
        // validation for constraint: array
        if ('' !== ($refundOptionDescriptionArrayErrorMessage = self::validateRefundOptionDescriptionForArrayConstraintsFromSetRefundOptionDescription($refundOptionDescription))) {
            throw new \InvalidArgumentException($refundOptionDescriptionArrayErrorMessage, __LINE__);
        }
        if (is_null($refundOptionDescription) || (is_array($refundOptionDescription) && empty($refundOptionDescription))) {
            unset($this->RefundOptionDescription);
        } else {
            $this->RefundOptionDescription = $refundOptionDescription;
        }
        return $this;
    }
    /**
     * Add item to RefundOptionDescription value
     * @throws \InvalidArgumentException
     * @param \patest\StructType\RefundOptionDescription $item
     * @return \patest\ArrayType\ArrayOfRefundOptionDescription
     */
    public function addToRefundOptionDescription(\patest\StructType\RefundOptionDescription $item)
    {
        // validation for constraint: itemType
        if (!$item instanceof \patest\StructType\RefundOptionDescription) {
            throw new \InvalidArgumentException(sprintf('The RefundOptionDescription property can only contain items of type \patest\StructType\RefundOptionDescription, %s given', is_object($item) ? get_class($item) : (is_array($item) ? implode(', ', $item) : gettype($item))), __LINE__);
        }
        $this->RefundOptionDescription[] = $item;
        return $this;
    }
    /**
     * Returns the current element
     * @see AbstractStructArrayBase::current()
     * @return \patest\StructType\RefundOptionDescription|null
     */
    public function current()
    {
        return parent::current();
    }
    /**
     * Returns the indexed element
     * @see AbstractStructArrayBase::item()
     * @param int $index
     * @return \patest\StructType\RefundOptionDescription|null
     */
    public function item($index)
    {
        return parent::item($index);
    }
    /**
     * Returns the first element
     * @see AbstractStructArrayBase::first()
     * @return \patest\StructType\RefundOptionDescription|null
     */
    public function first()
    {
        return parent::first();
    }
    /**
     * Returns the last element
     * @see AbstractStructArrayBase::last()
     * @return \patest\StructType\RefundOptionDescription|null
     */
    public function last()
    {
        return parent::last();
    }
    /**
     * Returns the element at the offset
     * @see AbstractStructArrayBase::offsetGet()
     * @param int $offset
     * @return \patest\StructType\RefundOptionDescription|null
     */
    public function offsetGet($offset)
    {
        return parent::offsetGet($offset);
    }
    /**
     * Returns the attribute name
     * @see AbstractStructArrayBase::getAttributeName()
     * @return string RefundOptionDescription
     */
    public function getAttributeName()
    {
        return 'RefundOptionDescription';
    }
}
