3 * A database result class
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
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;
30 * Current position in array
32 private $currentPos = -1;
37 private $currentRow = NULL;
42 private $resultArray = array();
45 * Array of out-dated entries
47 private $outDated = array();
52 private $affectedRows = 0;
57 private $foundValue = '';
60 * Protected constructor
64 protected function __construct () {
65 // Call parent constructor
66 parent::__construct(__CLASS__);
70 * Creates an instance of this result by a provided result array
72 * @param $resultArray The array holding the result from query
73 * @return $resultInstance An instance of this class
75 public static final function createDatabaseResult (array $resultArray) {
77 $resultInstance = new DatabaseResult();
79 // Set the result array
80 $resultInstance->setResultArray($resultArray);
83 $resultInstance->setAffectedRows(count($resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS]));
85 // Return the instance
86 return $resultInstance;
90 * Setter for result array
92 * @param $resultArray The array holding the result from query
95 protected final function setResultArray (array $resultArray) {
96 $this->resultArray = $resultArray;
100 * Updates the current entry by given update criteria
102 * @param $updateInstance An instance of an Updateable criteria
105 private function updateCurrentEntryByCriteria (LocalUpdateCriteria $updateInstance) {
106 // Get the current entry key
107 $entryKey = $this->key();
109 // Now get the update criteria array and update all entries
110 foreach ($updateInstance->getUpdateCriteria() as $criteriaKey => $criteriaValue) {
112 $this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][$entryKey][$criteriaKey] = $criteriaValue;
114 // Mark it as out-dated
115 $this->outDated[$criteriaKey] = 1;
120 * "Iterator" method next() to advance to the next valid entry. This method
121 * does also check if result is invalid
123 * @return $nextValid Wether the next entry is valid
125 public function next () {
126 // Default is not valid
129 // Is the result valid?
130 if ($this->valid()) {
131 // Next entry found, so count one up and cache it
133 $this->currentRow = $this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][$this->currentPos];
142 * Seeks for to a specified position
144 * @param $index Index to seek for
147 public function seek ($index) {
148 // Rewind to beginning
151 // Search for the entry
152 while ($this->currentPos < $index && ($this->valid())) {
159 * Gives back the current position or null if not found
161 * @return $current Current element to give back
163 public function current () {
164 // Default is not found
167 // Does the current enty exist?
168 if (isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][$this->currentPos])) {
170 $current = $this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][$this->currentPos];
178 * Checks if next() and rewind will give a valid result
180 * @return $isValid Wether the next/rewind entry is valid
182 public function valid () {
183 // By default nothing is valid
187 if (($this->ifStatusIsOkay()) && (isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][($this->currentPos + 1)])) && (isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_ROWS][0]))) {
197 * Determines wether the status of the query was fine (LocalfileDatabase::RESULT_OKAY)
199 * @return $ifStatusOkay Wether the status of the query was okay
201 public function ifStatusIsOkay () {
202 return ((isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_STATUS])) && ($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_STATUS] === LocalfileDatabase::RESULT_OKAY));
206 * Gets the current key of iteration
208 * @return $currentPos Key from iterator
210 public function key () {
211 return $this->currentPos;
215 * Rewind to the beginning and clear array $currentRow
219 public function rewind () {
220 $this->currentPos = -1;
221 $this->currentRow = array();
225 * Searches for an entry in data result and returns it
227 * @param $criteriaInstance The criteria to look inside the data set
228 * @return $result Found result entry
231 public function searchEntry (LocalSearchCriteria $criteriaInstance) {
232 $this->debugBackTrace(__METHOD__ . ': Unfinished!');
236 * Adds an update request to the database result for writing it to the
239 * @param $criteriaInstance An instance of a updateable criteria
241 * @throws ResultUpdateException If no result was updated
243 public function add2UpdateQueue (LocalUpdateCriteria $criteriaInstance) {
244 // Rewind the pointer
247 // Get search criteria
248 $searchInstance = $criteriaInstance->getSearchInstance();
250 // And start looking for the result
252 while (($this->valid()) && ($foundEntries < $searchInstance->getLimit())) {
255 $currentEntry = $this->current();
257 // Is this entry found?
258 if ($searchInstance->ifEntryMatches($currentEntry)) {
260 $this->updateCurrentEntryByCriteria($criteriaInstance);
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);
274 $this->setAffectedRows($foundEntries);
276 // Set update instance
277 $this->setUpdateInstance($criteriaInstance);
281 * Setter for affected rows
283 * @param $rows Number of affected rows
286 public final function setAffectedRows ($rows) {
287 $this->affectedRows = $rows;
291 * Getter for affected rows
293 * @return $rows Number of affected rows
295 public final function getAffectedRows () {
296 return $this->affectedRows;
300 * Getter for found value of previous found() call
302 * @return $foundValue Found value of previous found() call
304 public final function getFoundValue () {
305 return $this->foundValue;
309 * Checks wether we have out-dated entries or not
311 * @return $needsUpdate Wether we have out-dated entries
313 public function ifDataNeedsFlush () {
314 $needsUpdate = (count($this->outDated) > 0);
319 * Adds registration elements to a given dataset instance
321 * @param $criteriaInstance An instance of a storeable criteria
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)) {
331 $criteriaInstance->addCriteria($key, $this->getFoundValue());
337 * Find a key inside the result array
339 * @param $key The key we shall find
340 * @return $found Wether the key was found or not
342 public function find ($key) {
343 // By default nothing is found
346 // Rewind the pointer
349 // Walk through all entries
350 while ($this->valid()) {
351 // Advance to next entry
354 // Get the whole array
355 $currentEntry = $this->current();
357 // Is the element there?
358 if (isset($currentEntry[$key])) {
363 $this->foundValue = $currentEntry[$key];
365 // And stop searching
375 * Solver for result index value with call-back method
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
382 4 * @todo Find a caching way without modifying the result array
384 public function solveResultIndex ($databaseColumn, BaseDatabaseWrapper $wrapperInstance, array $callBack) {
385 // By default nothing is found
388 // Is the element in result itself found?
389 if ($this->find($databaseColumn)) {
391 $indexValue = $this->getFoundValue();
392 } elseif ($this->find($wrapperInstance->getIndexKey())) {
394 $indexValue = $this->getFoundValue();
398 call_user_func_array($callBack, array($indexValue));