SmartWebDK / module-testing

src/Util/BacksUpItems.php

<?php


namespace SmartWeb\ModuleTesting\Util;

use DeepCopy\DeepCopy;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use InvalidArgumentException;
use SmartWeb\ModuleTesting\Support\Concerns\MutatesAttributes;
use Traversable;


if (!function_exists('is_iterable')) {
    /**
     * true if a value is iterable and will be accepted by the iterable pseudo-type, false for other values.
     *
     * @param mixed $value
     *
     * @return bool
     *
     * @see  \is_iterable()
     * @link https://wiki.php.net/rfc/iterable
     */
    function is_iterable($value)

The function SmartWeb\ModuleTesting\Util\is_iterable() has been defined more than once; this definition is ignored, only the first definition in src/Helpers/helpers.php (L14-17) is considered.

    {
        return (is_array($value) || ($value instanceof Traversable));
    }
}


/**
 * Trait BacksUpItems
 *
 * @package SmartWeb\ModuleTesting\Util
 */
trait BacksUpItems
{
    
    use MutatesAttributes;
    
    /**
     * @var Collection
     */
    protected $items;
    
    /**
     * @var Collection
     */
    private $itemsBackup;
    
    /**
     * @var DeepCopy
     */
    private $copier;
    
    /**
     * @ignore
     *
     * @param $name
     *
     * @return mixed
     */
    final public function __get($name)
    {
        if ($this->hasGetMutator($name)) {
            return $this->getMutatedAttribute($name);
        }
        
        return $this->items[$name];
    }
    
    /**
     * @ignore
     *
     * @param $name
     * @param $value
     */
    final public function __set($name, $value)
    {
        $this->items[$name] = $value;
    }
    
    /**
     * @param mixed[] ...$items
     */
    final protected function inject(...$items)
    {
        $this->items = new Collection();
        
        foreach ($items as $item) {
            if (is_iterable($item) && Arr::isAssoc($item)) {
                $this->items = $this->items->merge($item);
            } else {
                throw new InvalidArgumentException("\$items must be an associative array.");
            }
        }
        
        $this->itemsBackup = $this->items ?? new Collection();
    }
    
    final protected function backupItems()
    {
        $this->itemsBackup = $this->getCopier()->copy($this->items ?? new Collection());
    }
    
    final protected function restoreItems()
    {
        $this->items = $this->getCopier()->copy($this->itemsBackup);
        $this->itemsBackup = null;
    }
    
    /**
     * @return DeepCopy
     */
    private function getCopier() : DeepCopy
    {
        return ($this->copier = $this->copier ?? new DeepCopy(true))->skipUncloneable();
    }
}