typo3/sysext/extbase/Classes/Persistence/BackendInterface.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
   6 *  All rights reserved
   7 *
   8 *  This class is a backport of the corresponding class of FLOW3.
   9 *  All credits go to the v5 team.
  10 *
  11 *  This script is part of the TYPO3 project. The TYPO3 project is
  12 *  free software; you can redistribute it and/or modify
  13 *  it under the terms of the GNU General Public License as published by
  14 *  the Free Software Foundation; either version 2 of the License, or
  15 *  (at your option) any later version.
  16 *
  17 *  The GNU General Public License can be found at
  18 *  http://www.gnu.org/copyleft/gpl.html.
  19 *
  20 *  This script is distributed in the hope that it will be useful,
  21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 *  GNU General Public License for more details.
  24 *
  25 *  This copyright notice MUST APPEAR in all copies of the script!
  26 ***************************************************************/
  27
  28 /**
  29  * A persistence backend interface
  30  *
  31  * @package Extbase
  32  * @subpackage Persistence
  33  * @version $Id: BackendInterface.php 2087 2009-03-26 16:46:14Z sebastian $
  34  */
  35 interface Tx_Extbase_Persistence_BackendInterface {
  36
  37         /**
  38          * Sets the aggregate root objects
  39          *
  40          * @param Tx_Extbase_Persistence_ObjectStorage $objects
  41          * @return void
  42          */
  43         public function setAggregateRootObjects(Tx_Extbase_Persistence_ObjectStorage $objects);
  44
  45         /**
  46          * Sets the deleted objects
  47          *
  48          * @param Tx_Extbase_Persistence_ObjectStorage $objects
  49          * @return void
  50          */
  51         public function setDeletedObjects(Tx_Extbase_Persistence_ObjectStorage $objects);
  52
  53         /**
  54          * Commits the current persistence session
  55          *
  56          * @return void
  57          */
  58         public function commit();
  59
  60         /**
  61          * Returns the (internal) identifier for the object, if it is known to the
  62          * backend. Otherwise NULL is returned.
  63          *
  64          * @param object $object
  65          * @return string The identifier for the object if it is known, or NULL
  66          */
  67         public function getIdentifierByObject($object);
  68
  69         /**
  70          * Checks if the given object has ever been persisted.
  71          *
  72          * @param object $object The object to check
  73          * @return boolean TRUE if the object is new, FALSE if the object exists in the repository
  74          */
  75         public function isNewObject($object);
  76
  77         /**
  78          * Replaces the given object by the second object.
  79          *
  80          * This method will unregister the existing object at the identity map and
  81          * register the new object instead. The existing object must therefore
  82          * already be registered at the identity map which is the case for all
  83          * reconstituted objects.
  84          *
  85          * The new object will be identified by the uuid which formerly belonged
  86          * to the existing object. The existing object looses its uuid.
  87          *
  88          * @param object $existingObject The existing object
  89          * @param object $newObject The new object
  90          * @return void
  91          */
  92         public function replaceObject($existingObject, $newObject);
  93 }
  94 ?>