Current File : /var/www/vinorea/src/Core/Data/AbstractTypedCollection.php |
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://devdocs.prestashop.com/ for more information.
*
* @author PrestaShop SA and Contributors <contact@prestashop.com>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
*/
namespace PrestaShop\PrestaShop\Core\Data;
use Doctrine\Common\Collections\ArrayCollection;
use PrestaShop\PrestaShop\Core\Exception\TypeException;
/**
* Class AbstractTypedCollection is an abstract collection class which checks
* that the inserted elements match the requested type.
*/
abstract class AbstractTypedCollection extends ArrayCollection
{
/**
* Define the type of the elements contained in the collection.
* Example: for a ProductCollection you need to return Product::class
*
* @return string
*/
abstract protected function getType();
/**
* AbstractTypedCollection constructor.
*
* @param array $elements
*
* @throws TypeException
*/
public function __construct(array $elements = [])
{
$this->checkElementsType($elements);
parent::__construct($elements);
}
/**
* @param mixed $element
*
* @return bool
*
* @throws TypeException
*/
public function removeElement($element)
{
$this->checkElementType($element);
return parent::removeElement($element);
}
/**
* @param mixed $offset
* @param mixed $value
*
* @return void
*
* @throws TypeException
*/
public function offsetSet($offset, $value): void
{
$this->checkElementType($value);
parent::offsetSet($offset, $value);
}
/**
* @param mixed $element
*
* @return bool
*
* @throws TypeException
*/
public function contains($element)
{
$this->checkElementType($element);
return parent::contains($element);
}
/**
* @param mixed $element
*
* @return bool|false|int|string
*
* @throws TypeException
*/
public function indexOf($element)
{
$this->checkElementType($element);
return parent::indexOf($element);
}
/**
* @param mixed $key
* @param mixed $value
*
* @throws TypeException
*/
public function set($key, $value)
{
$this->checkElementType($value);
parent::set($key, $value);
}
/**
* @param mixed $element
*
* @return bool
*
* @throws TypeException
*/
public function add($element)
{
$this->checkElementType($element);
return parent::add($element);
}
/**
* @param array $elements
*
* @throws TypeException
*/
private function checkElementsType(array $elements)
{
foreach ($elements as $element) {
$this->checkElementType($element);
}
}
/**
* @param mixed $element
*
* @throws TypeException
*/
private function checkElementType($element)
{
$expectedType = $this->getType();
if (!($element instanceof $expectedType)) {
throw new TypeException(sprintf('Invalid element type %s, expected %s', is_object($element) ? get_class($element) : gettype($element), $expectedType));
}
}
}