<?php

namespace dgsoft\ArrayType;

use \WsdlToPhp\PackageBase\AbstractStructArrayBase;

/**
 * This class stands for ArrayOfRatePlanCandidatesTypeRatePlanCandidate ArrayType
 * @package Dg
 * @subpackage Arrays
 */
class DgArrayOfRatePlanCandidatesTypeRatePlanCandidate extends AbstractStructArrayBase
{
    /**
     * The RatePlanCandidate
     * Meta informations extracted from the WSDL
     * - maxOccurs: unbounded
     * - minOccurs: 0
     * @var \dgsoft\StructType\DgRatePlanCandidate[]
     */
    public $RatePlanCandidate;
    /**
     * Constructor method for ArrayOfRatePlanCandidatesTypeRatePlanCandidate
     * @uses DgArrayOfRatePlanCandidatesTypeRatePlanCandidate::setRatePlanCandidate()
     * @param \dgsoft\StructType\DgRatePlanCandidate[] $ratePlanCandidate
     */
    public function __construct(array $ratePlanCandidate = array())
    {
        $this
            ->setRatePlanCandidate($ratePlanCandidate);
    }
    /**
     * Get RatePlanCandidate value
     * @return \dgsoft\StructType\DgRatePlanCandidate[]|null
     */
    public function getRatePlanCandidate()
    {
        return $this->RatePlanCandidate;
    }
    /**
     * Set RatePlanCandidate value
     * @throws \InvalidArgumentException
     * @param \dgsoft\StructType\DgRatePlanCandidate[] $ratePlanCandidate
     * @return \dgsoft\ArrayType\DgArrayOfRatePlanCandidatesTypeRatePlanCandidate
     */
    public function setRatePlanCandidate(array $ratePlanCandidate = array())
    {
        foreach ($ratePlanCandidate as $arrayOfRatePlanCandidatesTypeRatePlanCandidateRatePlanCandidateItem) {
            // validation for constraint: itemType
            if (!$arrayOfRatePlanCandidatesTypeRatePlanCandidateRatePlanCandidateItem instanceof \dgsoft\StructType\DgRatePlanCandidate) {
                throw new \InvalidArgumentException(sprintf('The RatePlanCandidate property can only contain items of \dgsoft\StructType\DgRatePlanCandidate, "%s" given', is_object($arrayOfRatePlanCandidatesTypeRatePlanCandidateRatePlanCandidateItem) ? get_class($arrayOfRatePlanCandidatesTypeRatePlanCandidateRatePlanCandidateItem) : gettype($arrayOfRatePlanCandidatesTypeRatePlanCandidateRatePlanCandidateItem)), __LINE__);
            }
        }
        $this->RatePlanCandidate = $ratePlanCandidate;
        return $this;
    }
    /**
     * Add item to RatePlanCandidate value
     * @throws \InvalidArgumentException
     * @param \dgsoft\StructType\DgRatePlanCandidate $item
     * @return \dgsoft\ArrayType\DgArrayOfRatePlanCandidatesTypeRatePlanCandidate
     */
    public function addToRatePlanCandidate(\dgsoft\StructType\DgRatePlanCandidate $item)
    {
        // validation for constraint: itemType
        if (!$item instanceof \dgsoft\StructType\DgRatePlanCandidate) {
            throw new \InvalidArgumentException(sprintf('The RatePlanCandidate property can only contain items of \dgsoft\StructType\DgRatePlanCandidate, "%s" given', is_object($item) ? get_class($item) : gettype($item)), __LINE__);
        }
        $this->RatePlanCandidate[] = $item;
        return $this;
    }
    /**
     * Returns the current element
     * @see AbstractStructArrayBase::current()
     * @return \dgsoft\StructType\DgRatePlanCandidate|null
     */
    public function current()
    {
        return parent::current();
    }
    /**
     * Returns the indexed element
     * @see AbstractStructArrayBase::item()
     * @param int $index
     * @return \dgsoft\StructType\DgRatePlanCandidate|null
     */
    public function item($index)
    {
        return parent::item($index);
    }
    /**
     * Returns the first element
     * @see AbstractStructArrayBase::first()
     * @return \dgsoft\StructType\DgRatePlanCandidate|null
     */
    public function first()
    {
        return parent::first();
    }
    /**
     * Returns the last element
     * @see AbstractStructArrayBase::last()
     * @return \dgsoft\StructType\DgRatePlanCandidate|null
     */
    public function last()
    {
        return parent::last();
    }
    /**
     * Returns the element at the offset
     * @see AbstractStructArrayBase::offsetGet()
     * @param int $offset
     * @return \dgsoft\StructType\DgRatePlanCandidate|null
     */
    public function offsetGet($offset)
    {
        return parent::offsetGet($offset);
    }
    /**
     * Returns the attribute name
     * @see AbstractStructArrayBase::getAttributeName()
     * @return string RatePlanCandidate
     */
    public function getAttributeName()
    {
        return 'RatePlanCandidate';
    }
    /**
     * Method called when an object has been exported with var_export() functions
     * It allows to return an object instantiated with the values
     * @see AbstractStructArrayBase::__set_state()
     * @uses AbstractStructArrayBase::__set_state()
     * @param array $array the exported values
     * @return \dgsoft\ArrayType\DgArrayOfRatePlanCandidatesTypeRatePlanCandidate
     */
    public static function __set_state(array $array)
    {
        return parent::__set_state($array);
    }
    /**
     * Method returning the class name
     * @return string __CLASS__
     */
    public function __toString()
    {
        return __CLASS__;
    }
}
