4724cc1787ea57280f2f07cdf7e0bbf3e74b3d8b
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / QueryResult.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
6 * All rights reserved
7 *
8 * This class is a backport of the corresponding class of FLOW3.
9 * All credits go to the v5 team.
10 *
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * A QueryResult object. Returned by Query->execute().
30 *
31 * @package Extbase
32 * @subpackage Persistence
33 * @version $Id$
34 * @scope prototype
35 */
36 class Tx_Extbase_Persistence_QueryResult implements Tx_Extbase_Persistence_QueryResultInterface {
37
38 /**
39 * @var array The rows of the query result
40 */
41 protected $rows;
42
43 /**
44 * Constructs this QueryResult
45 *
46 * @param array $rows The
47 */
48 public function __construct(array $rows) {
49 $this->rows = $rows;
50 }
51
52 /**
53 * Returns an array of all the column names in the table view of this result set.
54 *
55 * @return array array holding the column names.
56 */
57 public function getColumnNames() {
58 if (!is_null($this->rows)) {
59 return array_keys($this->rows[0]);
60 } else {
61 return array();
62 }
63 }
64
65 /**
66 * Returns an iterator over the Rows of the result table. The rows are
67 * returned according to the ordering specified in the query.
68 *
69 * @return Tx_Extbase_Persistence_RowIteratorInterface a RowIterator
70 * @throws Tx_Extbase_Persistence_Exception_RepositoryException if this call is the second time either getRows() or getNodes() has been called on the same QueryResult object or if another error occurs.
71 */
72 public function getRows() {
73 if ($this->rows === NULL) throw new Tx_Extbase_Persistence_Exception_RepositoryException('Illegal getRows() call - can be called only once.', 1237991809);
74
75 $rowIterator = t3lib_div::makeInstance('Tx_Extbase_Persistence_RowIterator');
76 foreach ($this->rows as $row) {
77 $rowIterator->append(t3lib_div::makeInstance('Tx_Extbase_Persistence_Row', $row));
78 }
79 $this->rows = NULL;
80
81 return $rowIterator;
82 }
83
84 }
85 ?>