<?php

namespace ArrayType;

use \WsdlToPhp\PackageBase\AbstractStructArrayBase;

/**
 * This class stands for ArrayOfJPSOAP_hotelRatePlanRate ArrayType
 * @subpackage Arrays
 */
class ArrayOfJPSOAP_hotelRatePlanRate extends AbstractStructArrayBase
{
    /**
     * The Rate
     * Meta information extracted from the WSDL
     * - maxOccurs: unbounded
     * - minOccurs: 0
     * @var \StructType\JPSOAP_hotelRatePlanRate[]
     */
    public $Rate;
    /**
     * Constructor method for ArrayOfJPSOAP_hotelRatePlanRate
     * @uses ArrayOfJPSOAP_hotelRatePlanRate::setRate()
     * @param \StructType\JPSOAP_hotelRatePlanRate[] $rate
     */
    public function __construct(array $rate = array())
    {
        $this
            ->setRate($rate);
    }
    /**
     * Get Rate value
     * @return \StructType\JPSOAP_hotelRatePlanRate[]|null
     */
    public function getRate()
    {
        return $this->Rate;
    }
    /**
     * This method is responsible for validating the values passed to the setRate method
     * This method is willingly generated in order to preserve the one-line inline validation within the setRate method
     * @param array $values
     * @return string A non-empty message if the values does not match the validation rules
     */
    public static function validateRateForArrayConstraintsFromSetRate(array $values = array())
    {
        $message = '';
        $invalidValues = [];
        foreach ($values as $arrayOfJPSOAP_hotelRatePlanRateRateItem) {
            // validation for constraint: itemType
            if (!$arrayOfJPSOAP_hotelRatePlanRateRateItem instanceof \StructType\JPSOAP_hotelRatePlanRate) {
                $invalidValues[] = is_object($arrayOfJPSOAP_hotelRatePlanRateRateItem) ? get_class($arrayOfJPSOAP_hotelRatePlanRateRateItem) : sprintf('%s(%s)', gettype($arrayOfJPSOAP_hotelRatePlanRateRateItem), var_export($arrayOfJPSOAP_hotelRatePlanRateRateItem, true));
            }
        }
        if (!empty($invalidValues)) {
            $message = sprintf('The Rate property can only contain items of type \StructType\JPSOAP_hotelRatePlanRate, %s given', is_object($invalidValues) ? get_class($invalidValues) : (is_array($invalidValues) ? implode(', ', $invalidValues) : gettype($invalidValues)));
        }
        unset($invalidValues);
        return $message;
    }
    /**
     * Set Rate value
     * @throws \InvalidArgumentException
     * @param \StructType\JPSOAP_hotelRatePlanRate[] $rate
     * @return \ArrayType\ArrayOfJPSOAP_hotelRatePlanRate
     */
    public function setRate(array $rate = array())
    {
        // validation for constraint: array
        if ('' !== ($rateArrayErrorMessage = self::validateRateForArrayConstraintsFromSetRate($rate))) {
            throw new \InvalidArgumentException($rateArrayErrorMessage, __LINE__);
        }
        $this->Rate = $rate;
        return $this;
    }
    /**
     * Add item to Rate value
     * @throws \InvalidArgumentException
     * @param \StructType\JPSOAP_hotelRatePlanRate $item
     * @return \ArrayType\ArrayOfJPSOAP_hotelRatePlanRate
     */
    public function addToRate(\StructType\JPSOAP_hotelRatePlanRate $item)
    {
        // validation for constraint: itemType
        if (!$item instanceof \StructType\JPSOAP_hotelRatePlanRate) {
            throw new \InvalidArgumentException(sprintf('The Rate property can only contain items of type \StructType\JPSOAP_hotelRatePlanRate, %s given', is_object($item) ? get_class($item) : (is_array($item) ? implode(', ', $item) : gettype($item))), __LINE__);
        }
        $this->Rate[] = $item;
        return $this;
    }
    /**
     * Returns the current element
     * @see AbstractStructArrayBase::current()
     * @return \StructType\JPSOAP_hotelRatePlanRate|null
     */
    public function current()
    {
        return parent::current();
    }
    /**
     * Returns the indexed element
     * @see AbstractStructArrayBase::item()
     * @param int $index
     * @return \StructType\JPSOAP_hotelRatePlanRate|null
     */
    public function item($index)
    {
        return parent::item($index);
    }
    /**
     * Returns the first element
     * @see AbstractStructArrayBase::first()
     * @return \StructType\JPSOAP_hotelRatePlanRate|null
     */
    public function first()
    {
        return parent::first();
    }
    /**
     * Returns the last element
     * @see AbstractStructArrayBase::last()
     * @return \StructType\JPSOAP_hotelRatePlanRate|null
     */
    public function last()
    {
        return parent::last();
    }
    /**
     * Returns the element at the offset
     * @see AbstractStructArrayBase::offsetGet()
     * @param int $offset
     * @return \StructType\JPSOAP_hotelRatePlanRate|null
     */
    public function offsetGet($offset)
    {
        return parent::offsetGet($offset);
    }
    /**
     * Returns the attribute name
     * @see AbstractStructArrayBase::getAttributeName()
     * @return string Rate
     */
    public function getAttributeName()
    {
        return 'Rate';
    }
}
