Add Extbase 1.0.1 to TYPO3core. Do NOT make changes inside! See misc/core_svn_rules...
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Row.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 row in the query result table.
30 *
31 * @package Extbase
32 * @subpackage Persistence
33 * @version $Id: Row.php 1729 2009-11-25 21:37:20Z stucki $
34 * @scope prototype
35 */
36 class Tx_Extbase_Persistence_Row implements Tx_Extbase_Persistence_RowInterface {
37
38 /**
39 * @var array
40 */
41 protected $tuple;
42
43 /**
44 * Constructs this Row instance
45 *
46 * @param array $tuple
47 */
48 public function __construct(array $tuple = array()) {
49 $this->tuple = $tuple;
50 }
51
52 /**
53 * @return boolean TRUE if the columnName is set
54 */
55 public function hasValue($columnName) {
56 return $this->offsetExists($columnName);
57 }
58
59 /**
60 * Returns an array of all the values in the same order as the column names
61 * returned by QueryResult.getColumnNames().
62 *
63 * @return array a Value array.
64 */
65 public function getValues() {
66 return array_values($this->tuple);
67 }
68
69 /**
70 * Returns the value of the indicated column in this Row.
71 *
72 * @param string $columnName name of query result table column
73 * @return Tx_Extbase_Persistence_ValueInterface a Value
74 */
75 public function getValue($columnName) {
76 return $this->offsetGet($columnName);
77 }
78
79 /**
80 * Loads the row at a given offset.
81 *
82 * @param string $offset
83 * @param mixed $value The value
84 * @return void
85 */
86 public function offsetSet($offset, $value) {
87 $this->tuple[$offset] = $value;
88 }
89
90 /**
91 * Checks if a given offset exists in the row
92 *
93 * @param string $offset
94 * @return boolean TRUE if the given offset exists; otherwise FALSE
95 */
96 public function offsetExists($offset) {
97 return isset($this->tuple[$offset]);
98 }
99
100 /**
101 * Unsets the storage at the given offset
102 *
103 * @param string $offset The offset
104 * @return void
105 */
106 public function offsetUnset($offset) {
107 unset($this->tuple[$offset]);
108 }
109
110 /**
111 * Returns the value at the given offset
112 *
113 * @param string $offset The offset
114 * @return The value|NULL if the offset does not exist
115 */
116 public function offsetGet($offset) {
117 return $this->offsetExists($offset) ? $this->tuple[$offset] : NULL;
118 }
119
120 }
121 ?>