IdentityMap.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
*  All rights reserved
*
*  This class is a backport of the corresponding class of FLOW3.
*  All credits go to the v5 team.
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

/**
 * An identity mapper to map nodes to objects
 *
 * @version $Id: IdentityMap.php 1814 2010-02-06 20:25:48Z jocrau $
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
 * @see \F3\TYPO3CR\FLOW3\Persistence\DataMapper, \F3\TYPO3CR\FLOW3\Persistence\Backend
 */
class Tx_Extbase_Persistence_IdentityMap implements t3lib_Singleton {

    /**
     * @var Tx_Extbase_Persistence_ObjectStorage
     */
    protected $objectMap;

    /**
     * @var array
     */
    protected $uuidMap = array();

    /**
     * Constructs a new Identity Map
     *
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function __construct() {
        $this->objectMap = new Tx_Extbase_Persistence_ObjectStorage();
    }

    /**
     * Checks whether the given object is known to the identity map
     *
     * @param object $object
     * @return boolean
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function hasObject($object) {
        return $this->objectMap->contains($object);
    }

    /**
     * Checks whether the given UUID is known to the identity map
     *
     * @param string $uuid
     * @param string $className
     * @return boolean
     */
    public function hasIdentifier($uuid, $className) {
        if (is_array($this->uuidMap[$className])) {
            return array_key_exists($uuid, $this->uuidMap[$className]);
        } else {
            return FALSE;
        }
    }

    /**
     * Returns the object for the given UUID
     *
     * @param string $uuid
     * @param string $className
     * @return object
     */
    public function getObjectByIdentifier($uuid, $className) {
        return $this->uuidMap[$className][$uuid];
    }

    /**
     * Returns the node identifier for the given object
     *
     * @param object $object
     * @return string
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function getIdentifierByObject($object) {
        if (!is_object($object)) throw new InvalidArgumentException('Object expected, ' . gettype($object) . ' given.', 1246892972);
        if (!isset($this->objectMap[$object])) {
            throw new Tx_Extbase_Persistence_Exception_UnknownObject('The given object (class: ' . get_class($object) . ') is not registered in this Identity Map.', 1246892970);
        }
        return $this->objectMap[$object];
    }

    /**
     * Register a node identifier for an object
     *
     * @param object $object
     * @param string $uuid
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function registerObject($object, $uuid) {
        $this->objectMap[$object] = $uuid;
        $this->uuidMap[get_class($object)][$uuid] = $object;
    }

    /**
     * Unregister an object
     *
     * @param string $object
     * @return void
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function unregisterObject($object) {
        unset($this->uuidMap[get_class($object)][$this->objectMap[$object]]);
        $this->objectMap->detach($object);
    }

}
?>