<?php

namespace Pepitelabs\PWS\EstimatingService;

use \WsdlToPhp\PackageBase\AbstractStructArrayBase;

/**
 * This class stands for ArrayOfShipmentEstimate EstimatingService
 * Meta information extracted from the WSDL
 * - nillable: true
 * - type: tns:ArrayOfShipmentEstimate
 * @subpackage Arrays
 */
class ArrayOfShipmentEstimate extends AbstractStructArrayBase
{
    /**
     * The ShipmentEstimate
     * Meta information extracted from the WSDL
     * - maxOccurs: unbounded
     * - minOccurs: 0
     * - nillable: true
     * @var \Pepitelabs\PWS\EstimatingService\ShipmentEstimate[]
     */
    public $ShipmentEstimate;
    /**
     * Constructor method for ArrayOfShipmentEstimate
     * @uses ArrayOfShipmentEstimate::setShipmentEstimate()
     * @param \Pepitelabs\PWS\EstimatingService\ShipmentEstimate[] $shipmentEstimate
     */
    public function __construct(array $shipmentEstimate = array())
    {
        $this
            ->setShipmentEstimate($shipmentEstimate);
    }
    /**
     * Get ShipmentEstimate 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 \Pepitelabs\PWS\EstimatingService\ShipmentEstimate[]|null
     */
    public function getShipmentEstimate()
    {
        return isset($this->ShipmentEstimate) ? $this->ShipmentEstimate : null;
    }
    /**
     * This method is responsible for validating the values passed to the setShipmentEstimate method
     * This method is willingly generated in order to preserve the one-line inline validation within the setShipmentEstimate method
     * @param array $values
     * @return string A non-empty message if the values does not match the validation rules
     */
    public static function validateShipmentEstimateForArrayConstraintsFromSetShipmentEstimate(array $values = array())
    {
        $message = '';
        $invalidValues = [];
        foreach ($values as $arrayOfShipmentEstimateShipmentEstimateItem) {
            // validation for constraint: itemType
            if (!$arrayOfShipmentEstimateShipmentEstimateItem instanceof \Pepitelabs\PWS\EstimatingService\ShipmentEstimate) {
                $invalidValues[] = is_object($arrayOfShipmentEstimateShipmentEstimateItem) ? get_class($arrayOfShipmentEstimateShipmentEstimateItem) : sprintf('%s(%s)', gettype($arrayOfShipmentEstimateShipmentEstimateItem), var_export($arrayOfShipmentEstimateShipmentEstimateItem, true));
            }
        }
        if (!empty($invalidValues)) {
            $message = sprintf('The ShipmentEstimate property can only contain items of type \Pepitelabs\PWS\EstimatingService\ShipmentEstimate, %s given', is_object($invalidValues) ? get_class($invalidValues) : (is_array($invalidValues) ? implode(', ', $invalidValues) : gettype($invalidValues)));
        }
        unset($invalidValues);
        return $message;
    }
    /**
     * Set ShipmentEstimate 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 \Pepitelabs\PWS\EstimatingService\ShipmentEstimate[] $shipmentEstimate
     * @return \Pepitelabs\PWS\EstimatingService\ArrayOfShipmentEstimate
     */
    public function setShipmentEstimate(array $shipmentEstimate = array())
    {
        // validation for constraint: array
        if ('' !== ($shipmentEstimateArrayErrorMessage = self::validateShipmentEstimateForArrayConstraintsFromSetShipmentEstimate($shipmentEstimate))) {
            throw new \InvalidArgumentException($shipmentEstimateArrayErrorMessage, __LINE__);
        }
        if (is_null($shipmentEstimate) || (is_array($shipmentEstimate) && empty($shipmentEstimate))) {
            unset($this->ShipmentEstimate);
        } else {
            $this->ShipmentEstimate = $shipmentEstimate;
        }
        return $this;
    }
    /**
     * Add item to ShipmentEstimate value
     * @throws \InvalidArgumentException
     * @param \Pepitelabs\PWS\EstimatingService\ShipmentEstimate $item
     * @return \Pepitelabs\PWS\EstimatingService\ArrayOfShipmentEstimate
     */
    public function addToShipmentEstimate(\Pepitelabs\PWS\EstimatingService\ShipmentEstimate $item)
    {
        // validation for constraint: itemType
        if (!$item instanceof \Pepitelabs\PWS\EstimatingService\ShipmentEstimate) {
            throw new \InvalidArgumentException(sprintf('The ShipmentEstimate property can only contain items of type \Pepitelabs\PWS\EstimatingService\ShipmentEstimate, %s given', is_object($item) ? get_class($item) : (is_array($item) ? implode(', ', $item) : gettype($item))), __LINE__);
        }
        $this->ShipmentEstimate[] = $item;
        return $this;
    }
    /**
     * Returns the current element
     * @see AbstractStructArrayBase::current()
     * @return \Pepitelabs\PWS\EstimatingService\ShipmentEstimate|null
     */
    public function current()
    {
        return parent::current();
    }
    /**
     * Returns the indexed element
     * @see AbstractStructArrayBase::item()
     * @param int $index
     * @return \Pepitelabs\PWS\EstimatingService\ShipmentEstimate|null
     */
    public function item($index)
    {
        return parent::item($index);
    }
    /**
     * Returns the first element
     * @see AbstractStructArrayBase::first()
     * @return \Pepitelabs\PWS\EstimatingService\ShipmentEstimate|null
     */
    public function first()
    {
        return parent::first();
    }
    /**
     * Returns the last element
     * @see AbstractStructArrayBase::last()
     * @return \Pepitelabs\PWS\EstimatingService\ShipmentEstimate|null
     */
    public function last()
    {
        return parent::last();
    }
    /**
     * Returns the element at the offset
     * @see AbstractStructArrayBase::offsetGet()
     * @param int $offset
     * @return \Pepitelabs\PWS\EstimatingService\ShipmentEstimate|null
     */
    public function offsetGet($offset)
    {
        return parent::offsetGet($offset);
    }
    /**
     * Returns the attribute name
     * @see AbstractStructArrayBase::getAttributeName()
     * @return string ShipmentEstimate
     */
    public function getAttributeName()
    {
        return 'ShipmentEstimate';
    }
    /**
     * 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 \Pepitelabs\PWS\EstimatingService\ArrayOfShipmentEstimate
     */
    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__;
    }
}