BackendInterface.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!
***************************************************************/

/**
 * Storage backend interface
 *
 * @package Extbase
 * @subpackage Persistence\Storage
 * @version $Id: BackendInterface.php 1971 2010-03-08 16:59:04Z jocrau $
 */
interface Tx_Extbase_Persistence_Storage_BackendInterface {

    /**
     * Adds a row to the storage
     *
     * @param string $tableName The database table name
     * @param array $row The row to insert
     * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
     * @return void
     */
    public function addRow($tableName, array $row, $isRelation = FALSE);

    /**
     * Updates a row in the storage
     *
     * @param string $tableName The database table name
     * @param array $row The row to update
     * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
     * @return void
     */
    public function updateRow($tableName, array $row, $isRelation = FALSE);

    /**
     * Deletes a row in the storage
     *
     * @param string $tableName The database table name
     * @param array $identifier An array of identifier array('fieldname' => value). This array will be transformed to a WHERE clause
     * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
     * @return void
     */
    public function removeRow($tableName, array $identifier, $isRelation = FALSE);

    /**
     * Returns the number of items matching the query.
     *
     * @param Tx_Extbase_Persistence_QueryInterface $query
     * @return integer
     * @api
     */
    public function getObjectCountByQuery(Tx_Extbase_Persistence_QueryInterface $query);

    /**
     * Returns the object data matching the $query.
     *
     * @param Tx_Extbase_Persistence_QueryInterface $query
     * @return array
     * @api
     */
    public function getObjectDataByQuery(Tx_Extbase_Persistence_QueryInterface $query);

}
?>