5 * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * * Neither the name of Sebastian Bergmann nor the names of his
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
39 * @author Mike Lively <m@digitalsandwich.com>
40 * @copyright 2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
41 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
43 * @link http://www.phpunit.de/
44 * @since File available since Release 3.2.0
47 require_once 'PHPUnit/Framework.php';
48 require_once 'PHPUnit/Util/Filter.php';
50 require_once 'PHPUnit/Extensions/Database/Operation/IDatabaseOperation.php';
51 require_once 'PHPUnit/Extensions/Database/Operation/Exception.php';
53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
56 * Provides basic functionality for row based operations.
58 * To create a row based operation you must create two functions. The first
59 * one, buildOperationQuery(), must return a query that will be used to create
60 * a prepared statement. The second one, buildOperationArguments(), should
61 * return an array containing arguments for each row.
65 * @author Mike Lively <m@digitalsandwich.com>
66 * @copyright 2009 Mike Lively <m@digitalsandwich.com>
67 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
68 * @version Release: 3.3.17
69 * @link http://www.phpunit.de/
70 * @since Class available since Release 3.2.0
72 abstract class PHPUnit_Extensions_Database_Operation_RowBased implements PHPUnit_Extensions_Database_Operation_IDatabaseOperation
74 const ITERATOR_TYPE_FORWARD = 0;
75 const ITERATOR_TYPE_REVERSE = 1;
77 protected $operationName;
79 protected $iteratorDirection = self::ITERATOR_TYPE_FORWARD;
81 protected abstract function buildOperationQuery(PHPUnit_Extensions_Database_DataSet_ITableMetaData $databaseTableMetaData, PHPUnit_Extensions_Database_DataSet_ITable $table, PHPUnit_Extensions_Database_DB_IDatabaseConnection $connection);
83 protected abstract function buildOperationArguments(PHPUnit_Extensions_Database_DataSet_ITableMetaData $databaseTableMetaData, PHPUnit_Extensions_Database_DataSet_ITable $table, $row);
86 * @param PHPUnit_Extensions_Database_DB_IDatabaseConnection $connection
87 * @param PHPUnit_Extensions_Database_DataSet_IDataSet $dataSet
89 public function execute(PHPUnit_Extensions_Database_DB_IDatabaseConnection $connection, PHPUnit_Extensions_Database_DataSet_IDataSet $dataSet)
91 $databaseDataSet = $connection->createDataSet();
93 $dsIterator = $this->iteratorDirection == self::ITERATOR_TYPE_REVERSE ? $dataSet->getReverseIterator() : $dataSet->getIterator();
95 foreach ($dsIterator as $table) {
96 /* @var $table PHPUnit_Extensions_Database_DataSet_ITable */
97 $databaseTableMetaData = $databaseDataSet->getTableMetaData($table->getTableMetaData()->getTableName());
98 $query = $this->buildOperationQuery($databaseTableMetaData, $table, $connection);
100 if ($query === FALSE && $table->getRowCount() > 0) {
101 throw new PHPUnit_Extensions_Database_Operation_Exception($this->operationName, '', array(), $table, "Rows requested for insert, but no columns provided!");
104 $statement = $connection->getConnection()->prepare($query);
105 for ($i = 0; $i < $table->getRowCount(); $i++) {
106 $args = $this->buildOperationArguments($databaseTableMetaData, $table, $i);
108 $statement->execute($args);
109 } catch (Exception $e) {
110 throw new PHPUnit_Extensions_Database_Operation_Exception($this->operationName, $query, $args, $table, $e->getMessage());
116 protected function buildPreparedColumnArray($columns, PHPUnit_Extensions_Database_DB_IDatabaseConnection $connection)
118 $columnArray = array();
119 foreach ($columns as $columnName) {
120 $columnArray[] = "{$connection->quoteSchemaObject($columnName)} = ?";