ObjectStorage.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Persistence;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

class ObjectStorage implements \Countable, \Iterator, \ArrayAccess, ObjectMonitoringInterface
{
    private $warning = 'You should never see this warning. If you do, you probably used PHP array functions like current() on the TYPO3\\CMS\\Extbase\\Persistence\\ObjectStorage. To retrieve the first result, you can use the rewind() and current() methods.';

    protected $storage = [];

    protected $isModified = false;

    protected $addedObjectsPositions = [];

    protected $removedObjectsPositions = [];

    protected $positionCounter = 0;

    public function rewind()
    {
        reset($this->storage);
    }

    public function valid()
    {
        return current($this->storage) !== false;
    }

    public function key()
    {
        return key($this->storage);
    }

    public function current()
    {
        $item = current($this->storage);
        return $item['obj'];
    }

    public function next()
    {
        next($this->storage);
    }

    public function count()
    {
        return count($this->storage);
    }

    public function offsetSet($object, $information)
    {
        $this->isModified = true;
        $this->storage[spl_object_hash($object)] = ['obj' => $object, 'inf' => $information];

        $this->positionCounter++;
        $this->addedObjectsPositions[spl_object_hash($object)] = $this->positionCounter;
    }

    public function offsetExists($object)
    {
        return is_object($object) && isset($this->storage[spl_object_hash($object)]);
    }

    public function offsetUnset($object)
    {
        $this->isModified = true;
        unset($this->storage[spl_object_hash($object)]);

        if (empty($this->storage)) {
            $this->positionCounter = 0;
        }

        $this->removedObjectsPositions[spl_object_hash($object)] = $this->addedObjectsPositions[spl_object_hash($object)];
        unset($this->addedObjectsPositions[spl_object_hash($object)]);
    }

    public function offsetGet($object)
    {
        return $this->storage[spl_object_hash($object)]['inf'];
    }

    public function contains($object)
    {
        return $this->offsetExists($object);
    }

    public function attach($object, $information = null)
    {
        $this->offsetSet($object, $information);
    }

    public function detach($object)
    {
        $this->offsetUnset($object);
    }

    public function getInfo()
    {
        $item = current($this->storage);
        return $item['inf'];
    }

    public function setInfo($data)
    {
        $this->isModified = true;
        $key = key($this->storage);
        $this->storage[$key]['inf'] = $data;
    }

    public function addAll(ObjectStorage $objectStorage)
    {
        foreach ($objectStorage as $object) {
            $this->attach($object, $objectStorage->getInfo());
        }
    }

    public function removeAll(ObjectStorage $objectStorage)
    {
        foreach ($objectStorage as $object) {
            $this->detach($object);
        }
    }

    public function toArray()
    {
        $array = [];
        $storage = array_values($this->storage);
        foreach ($storage as $item) {
            $array[] = $item['obj'];
        }
        return $array;
    }

    public function getArray()
    {
        return $this->toArray();
    }

    public function serialize()
    {
        throw new \RuntimeException('An ObjectStorage instance cannot be serialized.', 1267700868);
    }

    public function unserialize($serialized)
    {
        throw new \RuntimeException('A ObjectStorage instance cannot be unserialized.', 1267700870);
    }

    public function _memorizeCleanState()
    {
        $this->isModified = false;
    }

    public function _isDirty()
    {
        return $this->isModified;
    }

    public function isRelationDirty($object)
    {
        return isset($this->addedObjectsPositions[spl_object_hash($object)])
                && isset($this->removedObjectsPositions[spl_object_hash($object)])
                && ($this->addedObjectsPositions[spl_object_hash($object)] !== $this->removedObjectsPositions[spl_object_hash($object)]);
    }

    public function getPosition($object)
    {
        if (!isset($this->addedObjectsPositions[spl_object_hash($object)])) {
            return null;
        }

        return $this->addedObjectsPositions[spl_object_hash($object)];
    }
}