Some minor improvements
[core.git] / inc / classes / main / result / class_DatabaseResult.php
1 <?php
2 /**
3  * A database result class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class DatabaseResult extends BaseFrameworkSystem implements SearchableResult, UpdateableResult, SeekableIterator {
25         // Exception constants
26         const EXCEPTION_INVALID_DATABASE_RESULT = 0x1c0;
27         const EXCEPTION_RESULT_UPDATE_FAILED    = 0x1c1;
28
29         /**
30          * Current position in array
31          */
32         private $currentPos = -1;
33
34         /**
35          * Current row
36          */
37         private $currentRow = NULL;
38
39         /**
40          * Result array
41          */
42         private $resultArray = array();
43
44         /**
45          * Array of out-dated entries
46          */
47         private $outDated = array();
48
49         /**
50          * Affected rows
51          */
52         private $affectedRows = 0;
53
54         /**
55          * Found value
56          */
57         private $foundValue = '';
58
59         /**
60          * Protected constructor
61          *
62          * @return      void
63          */
64         protected function __construct () {
65                 // Call parent constructor
66                 parent::__construct(__CLASS__);
67         }
68
69         /**
70          * Creates an instance of this result by a provided result array
71          *
72          * @param       $resultArray            The array holding the result from query
73          * @return      $resultInstance         An instance of this class
74          */
75         public static final function createDatabaseResult (array $resultArray) {
76                 // Get a new instance
77                 $resultInstance = new DatabaseResult();
78
79                 // Set the result array
80                 $resultInstance->setResultArray($resultArray);
81
82                 // Set affected rows
83                 $resultInstance->setAffectedRows(count($resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS]));
84
85                 // Return the instance
86                 return $resultInstance;
87         }
88
89         /**
90          * Setter for result array
91          *
92          * @param       $resultArray    The array holding the result from query
93          * @return      void
94          */
95         protected final function setResultArray (array $resultArray) {
96                 $this->resultArray = $resultArray;
97         }
98
99         /**
100          * Updates the current entry by given update criteria
101          *
102          * @param       $updateInstance         An instance of an Updateable criteria
103          * @return      void
104          */
105         private function updateCurrentEntryByCriteria (LocalUpdateCriteria $updateInstance) {
106                 // Get the current entry key
107                 $entryKey = $this->key();
108
109                 // Now get the update criteria array and update all entries
110                 foreach ($updateInstance->getUpdateCriteria() as $criteriaKey => $criteriaValue) {
111                         // Update data
112                         $this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][$entryKey][$criteriaKey] = $criteriaValue;
113
114                         // Mark it as out-dated
115                         $this->outDated[$criteriaKey] = 1;
116                 } // END - foreach
117         }
118
119         /**
120          * "Iterator" method next() to advance to the next valid entry. This method
121          * does also check if result is invalid
122          *
123          * @return      $nextValid      Wether the next entry is valid
124          */
125         public function next () {
126                 // Default is not valid
127                 $nextValid = false;
128
129                 // Is the result valid?
130                 if ($this->valid()) {
131                         // Next entry found, so count one up and cache it
132                         $this->currentPos++;
133                         $this->currentRow = $this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][$this->currentPos];
134                         $nextValid = true;
135                 } // END - if
136
137                 // Return the result
138                 return $nextValid;
139         }
140
141         /**
142          * Seeks for to a specified position
143          *
144          * @param       $index  Index to seek for
145          * @return      void
146          */
147         public function seek ($index) {
148                 // Rewind to beginning
149                 $this->rewind();
150
151                 // Search for the entry
152                 while ($this->currentPos < $index && ($this->valid())) {
153                         // Continue on
154                         $this->next();
155                 } // END - while
156         }
157
158         /**
159          * Gives back the current position or null if not found
160          *
161          * @return      $current        Current element to give back
162          */
163         public function current () {
164                 // Default is not found
165                 $current = NULL;
166
167                 // Does the current enty exist?
168                 if (isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][$this->currentPos])) {
169                         // Then get it
170                         $current = $this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][$this->currentPos];
171                 } // END - if
172
173                 // Return the result
174                 return $current;
175         }
176
177         /**
178          * Checks if next() and rewind will give a valid result
179          *
180          * @return      $isValid Wether the next/rewind entry is valid
181          */
182         public function valid () {
183                 // By default nothing is valid
184                 $isValid = false;
185
186                 // Check if 
187                 if (($this->ifStatusIsOkay()) && (isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][($this->currentPos + 1)])) && (isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][0]))) {
188                         // All fine!
189                         $isValid = true;
190                 } // END - if
191
192                 // Return the result
193                 return $isValid;
194         }
195
196         /**
197          * Determines wether the status of the query was fine (LocalfileDatabase::RESULT_OKAY)
198          *
199          * @return      $ifStatusOkay   Wether the status of the query was okay
200          */
201         public function ifStatusIsOkay () {
202                 return ((isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_STATUS])) && ($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_STATUS] === LocalfileDatabase::RESULT_OKAY));
203         }
204
205         /**
206          * Gets the current key of iteration
207          *
208          * @return      $currentPos     Key from iterator
209          */
210         public function key () {
211                 return $this->currentPos;
212         }
213
214         /**
215          * Rewind to the beginning and clear array $currentRow
216          *
217          * @return      void
218          */
219         public function rewind () {
220                 $this->currentPos = -1;
221                 $this->currentRow = array();
222         }
223
224         /**
225          * Searches for an entry in data result and returns it
226          *
227          * @param       $criteriaInstance       The criteria to look inside the data set
228          * @return      $result                         Found result entry
229          * @todo        0% done
230          */
231         public function searchEntry (LocalSearchCriteria $criteriaInstance) {
232                 $this->debugBackTrace('[' . '[' . __METHOD__ . ':' . __LINE__ . ']:  Unfinished!');
233         }
234
235         /**
236          * Adds an update request to the database result for writing it to the
237          * database layer
238          *
239          * @param       $criteriaInstance       An instance of a updateable criteria
240          * @return      void
241          * @throws      ResultUpdateException   If no result was updated
242          */
243         public function add2UpdateQueue (LocalUpdateCriteria $criteriaInstance) {
244                 // Rewind the pointer
245                 $this->rewind();
246
247                 // Get search criteria
248                 $searchInstance = $criteriaInstance->getSearchInstance();
249
250                 // And start looking for the result
251                 $foundEntries = 0;
252                 while (($this->valid()) && ($foundEntries < $searchInstance->getLimit())) {
253                         // Get next entry
254                         $this->next();
255                         $currentEntry = $this->current();
256
257                         // Is this entry found?
258                         if ($searchInstance->ifEntryMatches($currentEntry)) {
259                                 // Update this entry
260                                 $this->updateCurrentEntryByCriteria($criteriaInstance);
261
262                                 // Count one up
263                                 $foundEntries++;
264                         } // END - if
265                 } // END - while
266
267                 // If no entry is found/updated throw an exception
268                 if ($foundEntries == 0) {
269                         // Throw an exception here
270                         throw new ResultUpdateException($this, self::EXCEPTION_RESULT_UPDATE_FAILED);
271                 } // END - if
272
273                 // Set affected rows
274                 $this->setAffectedRows($foundEntries);
275
276                 // Set update instance
277                 $this->setUpdateInstance($criteriaInstance);
278         }
279
280         /**
281          * Setter for affected rows
282          *
283          * @param       $rows   Number of affected rows
284          * @return      void
285          */
286         public final function setAffectedRows ($rows) {
287                 $this->affectedRows = $rows;
288         }
289
290         /**
291          * Getter for affected rows
292          *
293          * @return      $rows   Number of affected rows
294          */
295         public final function getAffectedRows () {
296                 return $this->affectedRows;
297         }
298
299         /**
300          * Getter for found value of previous found() call
301          *
302          * @return      $foundValue             Found value of previous found() call
303          */
304         public final function getFoundValue () {
305                 return $this->foundValue;
306         }
307
308         /**
309          * Checks wether we have out-dated entries or not
310          *
311          * @return      $needsUpdate    Wether we have out-dated entries
312          */
313         public function ifDataNeedsFlush () {
314                 $needsUpdate = (count($this->outDated) > 0);
315                 return $needsUpdate;
316         }
317
318         /**
319          * Adds registration elements to a given dataset instance
320          *
321          * @param       $criteriaInstance       An instance of a storeable criteria
322          * @return      void
323          */
324         public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
325                 // Walk only through out-dated columns
326                 foreach ($this->outDated as $key => $dummy) {
327                         // Does this key exist?
328                         //* DEBUG: */ echo "outDated: {$key}<br />\n";
329                         if ($this->find($key)) {
330                                 // Then update it
331                                 $criteriaInstance->addCriteria($key, $this->getFoundValue());
332                         } // END - if
333                 } // END - foreach
334         }
335
336         /**
337          * Find a key inside the result array
338          *
339          * @param       $key    The key we shall find
340          * @return      $found  Wether the key was found or not
341          */
342         public function find ($key) {
343                 // By default nothing is found
344                 $found = false;
345
346                 // Rewind the pointer
347                 $this->rewind();
348
349                 // Walk through all entries
350                 while ($this->valid()) {
351                         // Advance to next entry
352                         $this->next();
353
354                         // Get the whole array
355                         $currentEntry = $this->current();
356
357                         // Is the element there?
358                         if (isset($currentEntry[$key])) {
359                                 // Okay, found!
360                                 $found = true;
361
362                                 // So "cache" it
363                                 $this->foundValue = $currentEntry[$key];
364
365                                 // And stop searching
366                                 break;
367                         } // END - if
368                 } // END - while
369
370                 // Return the result
371                 return $found;
372         }
373
374         /**
375          * Solver for result index value with call-back method
376          *
377          * @param       $databaseColumn         Database column where the index might be found
378          * @param       $wrapperInstance        The wrapper instance to ask for array element
379          * @para        $callBack                       Call-back object for setting the index;
380          *                                                              0=object instance,1=method name
381          * @return      void
382 4        * @todo        Find a caching way without modifying the result array
383          */
384         public function solveResultIndex ($databaseColumn, BaseDatabaseWrapper $wrapperInstance, array $callBack) {
385                 // By default nothing is found
386                 $indexValue = 0;
387
388                 // Is the element in result itself found?
389                 if ($this->find($databaseColumn)) {
390                         // Use this value
391                         $indexValue = $this->getFoundValue();
392                 } elseif ($this->find($wrapperInstance->getIndexKey())) {
393                         // Use this value
394                         $indexValue = $this->getFoundValue();
395                 }
396
397                 // Set the index
398                 call_user_func_array($callBack, array($indexValue));
399         }
400 }
401
402 // [EOF]
403 ?>