3 namespace CoreFramework\Result\Database;
5 // Import framework stuff
6 use CoreFramework\Criteria\Local\LocalSearchCriteria;
7 use CoreFramework\Criteria\Local\LocalUpdateCriteria;
8 use CoreFramework\Criteria\Storing\StoreableCriteria;
9 use CoreFramework\Database\Backend\BaseDatabaseBackend;
10 use CoreFramework\Request\Requestable;
11 use CoreFramework\Result\Search\SearchableResult;
12 use CoreFramework\Result\Update\UpdateableResult;
13 use CoreFramework\Wrapper\Database\DatabaseWrapper;
16 * A database result class
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResult, UpdateableResult, SeekableIterator {
38 // Exception constants
39 const EXCEPTION_INVALID_DATABASE_RESULT = 0x1c0;
40 const EXCEPTION_RESULT_UPDATE_FAILED = 0x1c1;
43 * Current position in array
45 private $currentPos = -1;
50 private $currentRow = NULL;
55 private $resultArray = array();
58 * Array of out-dated entries
60 private $outDated = array();
65 private $affectedRows = 0;
70 private $foundValue = '';
73 * Protected constructor
77 protected function __construct () {
78 // Call parent constructor
79 parent::__construct(__CLASS__);
83 * Creates an instance of this result by a provided result array
85 * @param $resultArray The array holding the result from query
86 * @return $resultInstance An instance of this class
88 public static final function createCachedDatabaseResult (array $resultArray) {
90 $resultInstance = new CachedDatabaseResult();
92 // Set the result array
93 $resultInstance->setResultArray($resultArray);
96 $resultInstance->setAffectedRows(count($resultArray[BaseDatabaseBackend::RESULT_INDEX_ROWS]));
98 // Return the instance
99 return $resultInstance;
103 * Setter for result array
105 * @param $resultArray The array holding the result from query
108 protected final function setResultArray (array $resultArray) {
109 $this->resultArray = $resultArray;
113 * Updates the current entry by given update criteria
115 * @param $updateInstance An instance of an Updateable criteria
118 private function updateCurrentEntryByCriteria (LocalUpdateCriteria $updateInstance) {
119 // Get the current entry key
120 $entryKey = $this->key();
122 // Now get the update criteria array and update all entries
123 foreach ($updateInstance->getUpdateCriteria() as $criteriaKey => $criteriaValue) {
125 $this->resultArray[BaseDatabaseBackend::RESULT_INDEX_ROWS][$entryKey][$criteriaKey] = $criteriaValue;
127 // Mark it as out-dated
128 $this->outDated[$criteriaKey] = 1;
133 * "Iterator" method next() to advance to the next valid entry. This method
134 * does also check if result is invalid
136 * @return $nextValid Whether the next entry is valid
138 public function next () {
139 // Default is not valid
142 // Is the result valid?
143 if ($this->valid()) {
144 // Next entry found, so count one up and cache it
146 $this->currentRow = $this->resultArray[BaseDatabaseBackend::RESULT_INDEX_ROWS][$this->currentPos];
155 * Seeks for to a specified position
157 * @param $index Index to seek for
160 public function seek ($index) {
161 // Rewind to beginning
164 // Search for the entry
165 while (($this->currentPos < $index) && ($this->valid())) {
172 * Gives back the current position or null if not found
174 * @return $current Current element to give back
176 public function current () {
177 // Default is not found
180 // Does the current enty exist?
181 if (isset($this->resultArray[BaseDatabaseBackend::RESULT_INDEX_ROWS][$this->currentPos])) {
183 $current = $this->resultArray[BaseDatabaseBackend::RESULT_INDEX_ROWS][$this->currentPos];
191 * Checks if next() and rewind will give a valid result
193 * @return $isValid Whether the next/rewind entry is valid
195 public function valid () {
196 // By default nothing is valid
200 //*NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] this->currentPos=' . $this->currentPos);
202 // Check if all is fine ...
203 if (($this->ifStatusIsOkay()) && (isset($this->resultArray[BaseDatabaseBackend::RESULT_INDEX_ROWS][($this->currentPos + 1)])) && (isset($this->resultArray[BaseDatabaseBackend::RESULT_INDEX_ROWS][0]))) {
213 * Returns count of entries
215 * @return $isValid Whether the next/rewind entry is valid
217 public function count () {
219 return count($this->resultArray[BaseDatabaseBackend::RESULT_INDEX_ROWS]);
223 * Determines whether the status of the query was fine (BaseDatabaseBackend::RESULT_OKAY)
225 * @return $ifStatusOkay Whether the status of the query was okay
227 public function ifStatusIsOkay () {
228 $ifStatusOkay = ((isset($this->resultArray[BaseDatabaseBackend::RESULT_INDEX_STATUS])) && ($this->resultArray[BaseDatabaseBackend::RESULT_INDEX_STATUS] === BaseDatabaseBackend::RESULT_OKAY));
229 //*NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] ifStatusOkay=' . intval($ifStatusOkay));
230 return $ifStatusOkay;
234 * Gets the current key of iteration
236 * @return $currentPos Key from iterator
238 public function key () {
239 return $this->currentPos;
243 * Rewind to the beginning and clear array $currentRow
247 public function rewind () {
248 $this->currentPos = -1;
249 $this->currentRow = array();
253 * Searches for an entry in data result and returns it
255 * @param $criteriaInstance The criteria to look inside the data set
256 * @return $result Found result entry
259 public function searchEntry (LocalSearchCriteria $criteriaInstance) {
260 $this->debugBackTrace('[' . '[' . __METHOD__ . ':' . __LINE__ . ']: Unfinished!');
264 * Adds an update request to the database result for writing it to the
267 * @param $criteriaInstance An instance of a updateable criteria
269 * @throws ResultUpdateException If no result was updated
271 public function add2UpdateQueue (LocalUpdateCriteria $criteriaInstance) {
272 // Rewind the pointer
275 // Get search criteria
276 $searchInstance = $criteriaInstance->getSearchInstance();
278 // And start looking for the result
280 while (($this->valid()) && ($foundEntries < $searchInstance->getLimit())) {
283 $currentEntry = $this->current();
285 // Is this entry found?
286 if ($searchInstance->ifEntryMatches($currentEntry)) {
288 $this->updateCurrentEntryByCriteria($criteriaInstance);
295 // If no entry is found/updated throw an exception
296 if ($foundEntries == 0) {
297 // Throw an exception here
298 throw new ResultUpdateException($this, self::EXCEPTION_RESULT_UPDATE_FAILED);
302 $this->setAffectedRows($foundEntries);
304 // Set update instance
305 $this->setUpdateInstance($criteriaInstance);
309 * Setter for affected rows
311 * @param $rows Number of affected rows
314 public final function setAffectedRows ($rows) {
315 $this->affectedRows = $rows;
319 * Getter for affected rows
321 * @return $rows Number of affected rows
323 public final function getAffectedRows () {
324 return $this->affectedRows;
328 * Getter for found value of previous found() call
330 * @return $foundValue Found value of previous found() call
332 public final function getFoundValue () {
333 return $this->foundValue;
337 * Checks whether we have out-dated entries or not
339 * @return $needsUpdate Whether we have out-dated entries
341 public function ifDataNeedsFlush () {
342 $needsUpdate = (count($this->outDated) > 0);
347 * Adds registration elements to a given dataset instance
349 * @param $criteriaInstance An instance of a StoreableCriteria class
350 * @param $requestInstance An instance of a Requestable class
353 public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) {
354 // Walk only through out-dated columns
355 foreach ($this->outDated as $key => $dummy) {
356 // Does this key exist?
357 //* DEBUG: */ echo "outDated: {$key}<br />\n";
358 if ($this->find($key)) {
360 $criteriaInstance->addCriteria($key, $this->getFoundValue());
366 * Find a key inside the result array
368 * @param $key The key we shall find
369 * @return $found Whether the key was found or not
371 public function find ($key) {
372 // By default nothing is found
375 // Rewind the pointer
378 // Walk through all entries
379 while ($this->valid()) {
380 // Advance to next entry
383 // Get the whole array
384 $currentEntry = $this->current();
386 // Is the element there?
387 if (isset($currentEntry[$key])) {
392 $this->foundValue = $currentEntry[$key];
394 // And stop searching
404 * Solver for result index value with call-back method
406 * @param $databaseColumn Database column where the index might be found
407 * @param $wrapperInstance The wrapper instance to ask for array element
408 * @para $callBack Call-back object for setting the index;
409 * 0=object instance,1=method name
411 * @todo Find a caching way without modifying the result array
413 public function solveResultIndex ($databaseColumn, DatabaseWrapper $wrapperInstance, array $callBack) {
414 // By default nothing is found
417 // Is the element in result itself found?
418 if ($this->find($databaseColumn)) {
420 $indexValue = $this->getFoundValue();
421 } elseif ($this->find($wrapperInstance->getIndexKey())) {
423 $indexValue = $this->getFoundValue();
427 call_user_func_array($callBack, array($indexValue));