| Current Path : /var/www/surf/TYPO3/vendor/typo3/cms-extbase/Classes/Persistence/Generic/ |
| Current File : /var/www/surf/TYPO3/vendor/typo3/cms-extbase/Classes/Persistence/Generic/BackendInterface.php |
<?php
/*
* 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!
*/
namespace TYPO3\CMS\Extbase\Persistence\Generic;
use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
use TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
use TYPO3\CMS\Extbase\Persistence\QueryInterface;
/**
* A persistence backend interface
*/
interface BackendInterface
{
/**
* Set a PersistenceManager instance.
*/
public function setPersistenceManager(PersistenceManagerInterface $persistenceManager);
/**
* Sets the aggregate root objects
*/
public function setAggregateRootObjects(ObjectStorage $objects);
/**
* Sets the deleted entities
*/
public function setDeletedEntities(ObjectStorage $entities);
/**
* Sets the changed objects
*/
public function setChangedEntities(ObjectStorage $entities);
/**
* Commits the current persistence session
*/
public function commit();
// @todo refactor towards being closer to the Flow backend interface again
/**
* Returns the (internal) identifier for the object, if it is known to the
* backend. Otherwise NULL is returned.
*
* @param object $object
* @return string|null The identifier for the object if it is known, or NULL
*/
public function getIdentifierByObject($object);
/**
* Returns the object with the (internal) identifier, if it is known to the
* backend. Otherwise NULL is returned.
*
* @param string $identifier
* @param string $className
* @return object|null The object for the identifier if it is known, or NULL
*/
public function getObjectByIdentifier($identifier, $className);
/**
* Checks if the given object has ever been persisted.
*
* @param object $object The object to check
* @return bool TRUE if the object is new, FALSE if the object exists in the repository
*/
public function isNewObject($object);
/**
* Returns the number of records matching the query.
*
* @return int
*/
public function getObjectCountByQuery(QueryInterface $query);
/**
* Returns the object data matching the $query.
*
* @return array
*/
public function getObjectDataByQuery(QueryInterface $query);
}