| 1 |
lars |
1 |
<?php
|
|
|
2 |
/**
|
|
|
3 |
* PHPUnit
|
|
|
4 |
*
|
|
|
5 |
* Copyright (c) 2002-2010, Sebastian Bergmann <sb@sebastian-bergmann.de>.
|
|
|
6 |
* All rights reserved.
|
|
|
7 |
*
|
|
|
8 |
* Redistribution and use in source and binary forms, with or without
|
|
|
9 |
* modification, are permitted provided that the following conditions
|
|
|
10 |
* are met:
|
|
|
11 |
*
|
|
|
12 |
* * Redistributions of source code must retain the above copyright
|
|
|
13 |
* notice, this list of conditions and the following disclaimer.
|
|
|
14 |
*
|
|
|
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
|
|
|
18 |
* distribution.
|
|
|
19 |
*
|
|
|
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.
|
|
|
23 |
*
|
|
|
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.
|
|
|
36 |
*
|
|
|
37 |
* @category Testing
|
|
|
38 |
* @package PHPUnit
|
|
|
39 |
* @author Mike Lively <m@digitalsandwich.com>
|
|
|
40 |
* @copyright 2002-2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
|
|
|
41 |
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
|
|
42 |
* @link http://www.phpunit.de/
|
|
|
43 |
* @since File available since Release 3.2.0
|
|
|
44 |
*/
|
|
|
45 |
|
|
|
46 |
require_once 'PHPUnit/Util/Filter.php';
|
|
|
47 |
|
|
|
48 |
require_once 'PHPUnit/Extensions/Database/DataSet/AbstractDataSet.php';
|
|
|
49 |
require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTableIterator.php';
|
|
|
50 |
require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTable.php';
|
|
|
51 |
require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTableMetaData.php';
|
|
|
52 |
|
|
|
53 |
PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
|
|
|
54 |
|
|
|
55 |
/**
|
|
|
56 |
* Creates CsvDataSets.
|
|
|
57 |
*
|
|
|
58 |
* You can incrementally add CSV files as tables to your datasets
|
|
|
59 |
*
|
|
|
60 |
* @category Testing
|
|
|
61 |
* @package PHPUnit
|
|
|
62 |
* @author Mike Lively <m@digitalsandwich.com>
|
|
|
63 |
* @copyright 2010 Mike Lively <m@digitalsandwich.com>
|
|
|
64 |
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
|
|
|
65 |
* @version Release: 3.4.15
|
|
|
66 |
* @link http://www.phpunit.de/
|
|
|
67 |
* @since Class available since Release 3.3.0
|
|
|
68 |
*/
|
|
|
69 |
class PHPUnit_Extensions_Database_DataSet_CsvDataSet extends PHPUnit_Extensions_Database_DataSet_AbstractDataSet
|
|
|
70 |
{
|
|
|
71 |
protected $tables = array();
|
|
|
72 |
protected $delimiter = ',';
|
|
|
73 |
protected $enclosure = '"';
|
|
|
74 |
protected $escape = '"';
|
|
|
75 |
|
|
|
76 |
/**
|
|
|
77 |
* Creates a new CSV dataset
|
|
|
78 |
*
|
|
|
79 |
* You can pass in the parameters for how csv files will be read.
|
|
|
80 |
*
|
|
|
81 |
* @param string $delimiter
|
|
|
82 |
* @param string $enclosure
|
|
|
83 |
* @param string $escape
|
|
|
84 |
*/
|
|
|
85 |
public function __construct($delimiter = ',', $enclosure = '"', $escape = '"')
|
|
|
86 |
{
|
|
|
87 |
$this->delimiter = $delimiter;
|
|
|
88 |
$this->enclosure = $enclosure;
|
|
|
89 |
$this->escape = $escape;
|
|
|
90 |
}
|
|
|
91 |
|
|
|
92 |
/**
|
|
|
93 |
* Adds a table to the dataset
|
|
|
94 |
*
|
|
|
95 |
* The table will be given the passed name. $csvFile should be a path to
|
|
|
96 |
* a valid csv file (based on the arguments passed to the constructor.)
|
|
|
97 |
*
|
|
|
98 |
* @param string $tableName
|
|
|
99 |
* @param string $csvFile
|
|
|
100 |
*/
|
|
|
101 |
public function addTable($tableName, $csvFile)
|
|
|
102 |
{
|
|
|
103 |
if (!is_file($csvFile)) {
|
|
|
104 |
throw new InvalidArgumentException("Could not find csv file: {$csvFile}");
|
|
|
105 |
}
|
|
|
106 |
|
|
|
107 |
if (!is_readable($csvFile)) {
|
|
|
108 |
throw new InvalidArgumentException("Could not read csv file: {$csvFile}");
|
|
|
109 |
}
|
|
|
110 |
|
|
|
111 |
$fh = fopen($csvFile, 'r');
|
|
|
112 |
$columns = $this->getCsvRow($fh);
|
|
|
113 |
|
|
|
114 |
if ($columns === FALSE)
|
|
|
115 |
{
|
|
|
116 |
throw new InvalidArgumentException("Could not determine the headers from the given file {$csvFile}");
|
|
|
117 |
}
|
|
|
118 |
|
|
|
119 |
$metaData = new PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData($tableName, $columns);
|
|
|
120 |
$table = new PHPUnit_Extensions_Database_DataSet_DefaultTable($metaData);
|
|
|
121 |
|
|
|
122 |
while (($row = $this->getCsvRow($fh)) !== FALSE)
|
|
|
123 |
{
|
|
|
124 |
$table->addRow(array_combine($columns, $row));
|
|
|
125 |
}
|
|
|
126 |
|
|
|
127 |
$this->tables[$tableName] = $table;
|
|
|
128 |
}
|
|
|
129 |
|
|
|
130 |
/**
|
|
|
131 |
* Creates an iterator over the tables in the data set. If $reverse is
|
|
|
132 |
* true a reverse iterator will be returned.
|
|
|
133 |
*
|
|
|
134 |
* @param bool $reverse
|
|
|
135 |
* @return PHPUnit_Extensions_Database_DataSet_ITableIterator
|
|
|
136 |
*/
|
|
|
137 |
protected function createIterator($reverse = FALSE)
|
|
|
138 |
{
|
|
|
139 |
return new PHPUnit_Extensions_Database_DataSet_DefaultTableIterator($this->tables, $reverse);
|
|
|
140 |
}
|
|
|
141 |
|
|
|
142 |
/**
|
|
|
143 |
* Returns a row from the csv file in an indexed array.
|
|
|
144 |
*
|
|
|
145 |
* @param resource $fh
|
|
|
146 |
* @return array
|
|
|
147 |
*/
|
|
|
148 |
protected function getCsvRow($fh)
|
|
|
149 |
{
|
|
|
150 |
if (version_compare(PHP_VERSION, '5.3.0', '>')) {
|
|
|
151 |
return fgetcsv($fh, NULL, $this->delimiter, $this->enclosure, $this->escape);
|
|
|
152 |
} else {
|
|
|
153 |
return fgetcsv($fh, NULL, $this->delimiter, $this->enclosure);
|
|
|
154 |
}
|
|
|
155 |
}
|
|
|
156 |
}
|
|
|
157 |
?>
|