83 lines
2.9 KiB
PHP
83 lines
2.9 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* 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\Storage;
|
|
|
|
use TYPO3\CMS\Extbase\DomainObject\AbstractValueObject;
|
|
use TYPO3\CMS\Extbase\Persistence\QueryInterface;
|
|
|
|
/**
|
|
* Storage backend interface
|
|
*/
|
|
interface BackendInterface
|
|
{
|
|
/**
|
|
* Adds a row to the storage
|
|
*
|
|
* @param string $tableName The database table name
|
|
* @param array $fieldValues The fieldValues to insert
|
|
* @param bool $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
|
|
* @return int the UID of the inserted row
|
|
*/
|
|
public function addRow(string $tableName, array $fieldValues, bool $isRelation = false): int;
|
|
|
|
/**
|
|
* Updates a row in the storage
|
|
*
|
|
* @param string $tableName The database table name
|
|
* @param array $fieldValues The fieldValues to update
|
|
* @param bool $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
|
|
*/
|
|
public function updateRow(string $tableName, array $fieldValues, bool $isRelation = false): void;
|
|
|
|
/**
|
|
* Updates a relation row in the storage
|
|
*
|
|
* @param string $tableName The database relation table name
|
|
* @param array $fieldValues The fieldValues to be updated
|
|
*/
|
|
public function updateRelationTableRow(string $tableName, array $fieldValues): void;
|
|
|
|
/**
|
|
* Deletes a row in the storage
|
|
*
|
|
* @param string $tableName The database table name
|
|
* @param array $where An array of where array('fieldname' => value). This array will be transformed to a WHERE clause
|
|
* @param bool $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
|
|
*/
|
|
public function removeRow(string $tableName, array $where, bool $isRelation = false): void;
|
|
|
|
/**
|
|
* Returns the number of items matching the query.
|
|
*/
|
|
public function getObjectCountByQuery(QueryInterface $query): int;
|
|
|
|
/**
|
|
* Returns the object data matching the $query.
|
|
*/
|
|
public function getObjectDataByQuery(QueryInterface $query): array;
|
|
|
|
/**
|
|
* Checks if a Value Object equal to the given Object exists in the data base
|
|
*
|
|
* @param \TYPO3\CMS\Extbase\DomainObject\AbstractValueObject $object The Value Object
|
|
* @return int|null The matching uid if an object was found, else null
|
|
* @todo this is the last monster in this persistence series. refactor!
|
|
*/
|
|
public function getUidOfAlreadyPersistedValueObject(AbstractValueObject $object): ?int;
|
|
}
|