3 namespace Org\Mxchange\CoreFramework\Database\Backend\Lfdb;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Criteria\Criteria;
7 use Org\Mxchange\CoreFramework\Criteria\Local\LocalSearchCriteria;
8 use Org\Mxchange\CoreFramework\Criteria\Storing\StoreableCriteria;
9 use Org\Mxchange\CoreFramework\Database\Backend\BaseDatabaseBackend;
10 use Org\Mxchange\CoreFramework\Database\Backend\DatabaseBackend;
11 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
12 use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException;
13 use Org\Mxchange\CoreFramework\Generic\FrameworkException;
19 * Database backend class for storing objects in locally created files.
21 * This class serializes arrays stored in the dataset instance and saves them
22 * to local files. Every file (except 'info') represents a single line. Every
23 * directory within the 'db' (base) directory represents a table.
25 * A configurable 'file_io_class' is being used as "storage backend".
27 * @author Roland Haeder <webmaster@shipsimu.org>
29 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
30 * @license GNU GPL 3.0 or any newer version
31 * @link http://www.shipsimu.org
33 * This program is free software: you can redistribute it and/or modify
34 * it under the terms of the GNU General Public License as published by
35 * the Free Software Foundation, either version 3 of the License, or
36 * (at your option) any later version.
38 * This program is distributed in the hope that it will be useful,
39 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 * GNU General Public License for more details.
43 * You should have received a copy of the GNU General Public License
44 * along with this program. If not, see <http://www.gnu.org/licenses/>.
46 class CachedLocalFileDatabase extends BaseDatabaseBackend implements DatabaseBackend {
48 * The file's extension
50 private $fileExtension = 'serialized';
53 * The last read file's name
55 private $lastFile = '';
58 * The last read file's content including header information
60 private $lastContents = array();
63 * Whether the "connection is already up
65 private $alreadyConnected = false;
68 * Table information array
70 private $tableInfo = array();
75 private $indexKey = '__idx';
78 * The protected constructor. Do never instance from outside! You need to
79 * set a local file path. The class will then validate it.
83 protected function __construct () {
84 // Call parent constructor
85 parent::__construct(__CLASS__);
89 * Create an object of CachedLocalFileDatabase and set the save path from
90 * configuration for local files.
92 * @return $databaseInstance An instance of CachedLocalFileDatabase
94 public static final function createCachedLocalFileDatabase () {
96 $databaseInstance = new CachedLocalFileDatabase();
98 // Get a new compressor channel instance
99 $compressorInstance = ObjectFactory::createObjectByConfiguredName('compressor_channel_class');
101 // Set the compressor channel
102 $databaseInstance->setCompressorChannel($compressorInstance);
104 // Get a file IO handler
105 $fileIoInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
108 $databaseInstance->setFileIoInstance($fileIoInstance);
110 // "Connect" to the database
111 $databaseInstance->connectToDatabase();
113 // Return database instance
114 return $databaseInstance;
118 * Setter for the last read file
120 * @param $infoInstance The FQFN of the last read file
123 private final function setLastFile (SplFileInfo $infoInstance) {
124 // Cast string and set it
125 $this->lastFile = $infoInstance;
129 * Getter for last read file
131 * @return $lastFile The last read file's name with full path
133 public final function getLastFile () {
134 return $this->lastFile;
138 * Setter for contents of the last read file
140 * @param $contents An array with header and data elements
143 private final function setLastFileContents (array $contents) {
145 $this->lastContents = $contents;
149 * Getter for last read file's content as an array
151 * @return $lastContent The array with elements 'header' and 'data'.
153 public final function getLastContents () {
154 return $this->lastContents;
158 * Getter for file extension
160 * @return $fileExtension The array with elements 'header' and 'data'.
162 public final function getFileExtension () {
163 return $this->fileExtension;
167 * Getter for index key
169 * @return $indexKey Index key
171 public final function getIndexKey () {
172 return $this->indexKey;
176 * Reads a local data file and returns it's contents in an array
178 * @param $infoInstance An instance of a SplFileInfo class
181 private function getDataArrayFromFile (SplFileInfo $infoInstance) {
182 // Init compressed data
183 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: Reading elements from database file ' . $infoInstance . ' ...');
184 $compressedData = $this->getFileIoInstance()->loadFileContents($infoInstance);
185 $compressedData = $compressedData['data'];
188 $serializedData = $this->getCompressorChannel()->getCompressor()->decompressStream($compressedData);
191 $dataArray = json_decode($serializedData, true);
194 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: Read ' . count($dataArray) . ' elements from database file ' . $infoInstance . '.');
195 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: dataArray=' . print_r($dataArray, true));
200 * Writes data array to local file
202 * @param $infoInstance An instance of a SplFileInfo class
203 * @param $dataArray An array with all the data we shall write
206 private function writeDataArrayToFqfn (SplFileInfo $infoInstance, array $dataArray) {
207 // Serialize and compress it
208 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: Flushing ' . count($dataArray) . ' elements to database file ' . $infoInstance . ' ...');
209 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: dataArray=' . print_r($dataArray, true));
210 $compressedData = $this->getCompressorChannel()->getCompressor()->compressStream(json_encode($dataArray));
212 // Write this data BASE64 encoded to the file
213 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: Writing ' . strlen($compressedData) . ' bytes ...');
214 $this->getFileIoInstance()->saveStreamToFile($infoInstance, $compressedData, $this);
217 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: Flushing ' . count($dataArray) . ' elements to database file completed.');
221 * Getter for table information file contents or an empty if info file was not created
223 * @param $dataSetInstance An instance of a database set class
224 * @return $infoArray An array with all table informations
226 private function getContentsFromTableInfoFile (StoreableCriteria $dataSetInstance) {
227 // Default content is no data
228 $infoArray = array();
230 // Create FQFN for getting the table information file
231 $infoInstance = $this->generateFileFromDataSet($dataSetInstance, 'info');
233 // Get the file contents
235 $infoArray = $this->getDataArrayFromFile($infoInstance);
236 } catch (FileNotFoundException $e) {
237 // Not found, so ignore it here
245 * Generates a file info class from given dataset instance and string
247 * @param $dataSetInstance An instance of a database set class
248 * @param $rowName Name of the row
249 * @return $infoInstance An instance of a SplFileInfo class
251 private function generateFileFromDataSet (Criteria $dataSetInstance, $rowName) {
252 // Instanciate new file object
253 $infoInstance = new SplFileInfo($this->getConfigInstance()->getConfigEntry('local_database_path') . $dataSetInstance->getTableName() . DIRECTORY_SEPARATOR . $rowName . '.' . $this->getFileExtension());
256 return $infoInstance;
260 * Creates the table info file from given dataset instance
262 * @param $dataSetInstance An instance of a database set class
265 private function createTableInfoFile (StoreableCriteria $dataSetInstance) {
266 // Create FQFN for creating the table information file
267 $infoInstance = $this->generateFileFromDataSet($dataSetInstance, 'info');
269 // Get the data out from dataset in a local array
270 $this->tableInfo[$dataSetInstance->getTableName()] = array(
271 'primary' => $dataSetInstance->getPrimaryKey(),
273 'last_updated' => time()
276 // Write the data to the file
277 $this->writeDataArrayToFqfn($infoInstance, $this->tableInfo[$dataSetInstance->getTableName()]);
281 * Updates the table info file from given dataset instance
283 * @param $dataSetInstance An instance of a database set class
286 private function updateTableInfoFile (StoreableCriteria $dataSetInstance) {
287 // Get table name from criteria
288 $tableName = $dataSetInstance->getTableName();
290 // Create FQFN for creating the table information file
291 $infoInstance = $this->generateFileFromDataSet($dataSetInstance, 'info');
293 // Get the data out from dataset in a local array
294 $this->tableInfo[$tableName]['primary'] = $dataSetInstance->getPrimaryKey();
295 $this->tableInfo[$tableName]['last_updated'] = time();
297 // Write the data to the file
298 $this->writeDataArrayToFqfn($infoInstance, $this->tableInfo[$tableName]);
302 * Updates the primary key information or creates the table info file if not found
304 * @param $dataSetInstance An instance of a database set class
307 private function updatePrimaryKey (StoreableCriteria $dataSetInstance) {
308 // Get table name from criteria
309 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: dataSetInstance=%s - CALLED!', $dataSetInstance->__toString()));
310 $tableName = $dataSetInstance->getTableName();
312 // Get the information array from lower method
313 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: tableName=%s', $tableName));
314 $infoArray = $this->getContentsFromTableInfoFile($dataSetInstance);
316 // Is the primary key there?
317 //* PRINTR-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: tableInfo=' . print_r($this->tableInfo, true));
318 if (!isset($this->tableInfo[$tableName]['primary'])) {
319 // Then create the info file
320 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: Creating info table for tableName=%s ...', $tableName));
321 $this->createTableInfoFile($dataSetInstance);
322 } elseif (($this->getConfigInstance()->getConfigEntry('db_update_primary_forced') == 'Y') && ($dataSetInstance->getPrimaryKey() != $this->tableInfo[$tableName]['primary'])) {
323 // Set the array element
324 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: Setting primaryKey=%s for tableName=%s ...', $dataSetInstance->getPrimaryKey(), $tableName));
325 $this->tableInfo[$tableName]['primary'] = $dataSetInstance->getPrimaryKey();
328 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: Updating info table for tableName=%s ...', $tableName));
329 $this->updateTableInfoFile($dataSetInstance);
333 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: EXIT!');
337 * Makes sure that the database connection is alive
340 * @todo Do some checks on the database directory and files here
342 public function connectToDatabase () {
346 * Starts a SELECT query on the database by given return type, table name
347 * and search criteria
349 * @param $tableName Name of the database table
350 * @param $searchInstance Local search criteria class
351 * @return $resultData Result data of the query
352 * @throws UnsupportedCriteriaException If the criteria is unsupported
353 * @throws SqlException If an 'SQL error' occurs
355 public function querySelect ($tableName, LocalSearchCriteria $searchInstance) {
356 // The result is null by any errors
357 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: tableName=%s,searchInstance=%s - CALLED!', $tableName, $searchInstance->__toString()));
360 // Create full path name
361 $pathName = $this->getConfigInstance()->getConfigEntry('local_database_path') . $tableName . DIRECTORY_SEPARATOR;
364 * A 'select' query is not that easy on local files, so first try to
365 * find the 'table' which is in fact a directory on the server
368 // Get a directory pointer instance
369 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: Getting directory_class for pathName=%s ...', $pathName));
370 $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
372 // Initialize the result data, this need to be rewritten e.g. if a local file cannot be read
374 BaseDatabaseBackend::RESULT_INDEX_STATUS => self::RESULT_OKAY,
375 BaseDatabaseBackend::RESULT_INDEX_ROWS => array()
378 // Initialize limit/skip
383 // Read the directory with some exceptions
384 while (($fileInfoInstance = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) && (($limitFound < $searchInstance->getLimit()) || ($searchInstance->getLimit() == 0))) {
385 // Does the extension match?
386 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: fileInfoInstance->extension=%s,this->fileExtension=%s', $fileInfoInstance->getExtension(), $this->getFileExtension()));
387 if ($fileInfoInstance->getExtension() !== $this->getFileExtension()) {
389 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: Skipping fileInfoInstance->filename=%s ...', $fileInfoInstance->getFilename()));
390 $directoryInstance->getDirectoryIteratorInstance()->next();
395 $dataArray = $this->getDataArrayFromFile($fileInfoInstance);
398 //* PRINTR-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: fileInfoInstance.pathname=' . $fileInfoInstance->getPathname() . ',dataArray='.print_r($dataArray, true));
399 if (is_array($dataArray)) {
400 // Default is nothing found
403 // Search in the criteria with FMFW (First Matches, First Wins)
404 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: dataArray()=%d', count($dataArray)));
405 foreach ($dataArray as $key => $value) {
406 // Make sure value is not bool
407 assert(!is_bool($value));
410 $isFound = (($isFound === true) && ($searchInstance->isCriteriaMatching($key, $value)));
411 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: key=%s,value[%s]=%s,isFound=%s', $key, gettype($value), $value, intval($isFound)));
415 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: isFound=%d,limitFound=%d,limit=%d', intval($isFound), $limitFound, $searchInstance->getLimit()));
416 if ($isFound === true) {
417 // Shall we skip this entry?
418 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: searchInstance->skip=%d', $searchInstance->getSkip()));
419 if ($searchInstance->getSkip() > 0) {
420 // We shall skip some entries
421 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: skipFound=%s', $skipFound));
422 if ($skipFound < $searchInstance->getSkip()) {
430 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: Setting dataArray[%s]=%d', $this->getIndexKey(), $idx));
431 $dataArray[$this->getIndexKey()] = $idx;
434 array_push($resultData[BaseDatabaseBackend::RESULT_INDEX_ROWS], $dataArray);
436 // Count found entries up
437 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: resultData[%s]()=%d', BaseDatabaseBackend::RESULT_INDEX_ROWS, count($resultData[BaseDatabaseBackend::RESULT_INDEX_ROWS])));
441 // Throw an exception here
442 throw new SqlException(array($this, sprintf('File '%s' contains invalid data.', $fileInfoInstance->getPathname()), self::DB_CODE_DATA_FILE_CORRUPT), self::EXCEPTION_SQL_QUERY);
448 // Advance to next entry
449 $directoryInstance->getDirectoryIteratorInstance()->next();
452 // Close directory and throw the instance away
453 $directoryInstance->closeDirectory();
454 unset($directoryInstance);
456 // Reset last exception
457 $this->resetLastException();
458 } catch (PathIsNoDirectoryException $e) {
459 // Path not found means "table not found" for real databases...
460 $this->setLastException($e);
462 // So throw an SqlException here with faked error message
463 throw new SqlException (array($this, sprintf('Table '%s' not found', $tableName), self::DB_CODE_TABLE_MISSING), self::EXCEPTION_SQL_QUERY);
464 } catch (FrameworkException $e) {
465 // Catch all exceptions and store them in last error
466 $this->setLastException($e);
469 // Return the gathered result
474 * "Inserts" a data set instance into a local file database folder
476 * @param $dataSetInstance A storeable data set
478 * @throws SqlException If an SQL error occurs
480 public function queryInsertDataSet (StoreableCriteria $dataSetInstance) {
481 // Try to save the request away
482 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-LFDB: dataSetInstance=%s - CALLED!', $dataSetInstance->__toString()));
484 // Create full path name
485 $infoInstance = $this->generateFileFromDataSet($dataSetInstance, md5($dataSetInstance->getUniqueValue()));
487 // Write the data away
488 $this->writeDataArrayToFqfn($infoInstance, $dataSetInstance->getCriteriaArray());
490 // Update the primary key
491 $this->updatePrimaryKey($dataSetInstance);
493 // Reset last exception
494 $this->resetLastException();
495 } catch (FrameworkException $e) {
496 // Catch all exceptions and store them in last error
497 $this->setLastException($e);
499 // Throw an SQL exception
500 throw new SqlException(array(
502 sprintf('Cannot write data to table '%s', is the table created?', $dataSetInstance->getTableName()),
503 self::DB_CODE_TABLE_UNWRITEABLE
505 self::EXCEPTION_SQL_QUERY
510 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: EXIT!');
514 * "Updates" a data set instance with a database layer
516 * @param $dataSetInstance A storeable data set
518 * @throws SqlException If an SQL error occurs
520 public function queryUpdateDataSet (StoreableCriteria $dataSetInstance) {
521 // Create full path name
522 $pathName = $this->getConfigInstance()->getConfigEntry('local_database_path') . $dataSetInstance->getTableName() . DIRECTORY_SEPARATOR;
524 // Try all the requests
526 // Get a file pointer instance
527 $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
529 // Initialize limit/skip
533 // Get the criteria array from the dataset
534 $searchArray = $dataSetInstance->getCriteriaArray();
536 // Get search criteria
537 $searchInstance = $dataSetInstance->getSearchInstance();
539 // Read the directory with some exceptions
540 while (($fileInfoInstance = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) && (($limitFound < $searchInstance->getLimit()) || ($searchInstance->getLimit() == 0))) {
541 // Does the extension match?
542 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: fileInfoInstance->extension=' . $fileInfoInstance->getExtension() . ',this->getFileExtension()=' . $this->getFileExtension());
543 if ($fileInfoInstance->getExtension() !== $this->getFileExtension()) {
545 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: fileInfoInstance.extension=' . $fileInfoInstance->getExtension() . ',getFileExtension()=' . $this->getFileExtension() . ' - SKIPPED!');
546 $directoryInstance->getDirectoryIteratorInstance()->next();
550 // Open this file for reading
551 $dataArray = $this->getDataArrayFromFile($fileInfoInstance);
552 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: fileInfoInstance.pathname=' . $fileInfoInstance->getPathname() . ',dataArray='.print_r($dataArray, true));
555 if (is_array($dataArray)) {
556 // Default is nothing found
559 // Search in the criteria with FMFW (First Matches, First Wins)
560 foreach ($dataArray as $key => $value) {
561 // Make sure value is not bool
562 assert(!is_bool($value));
565 $isFound = (($isFound === true) && ($searchInstance->isCriteriaMatching($key, $value)));
569 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: isFound=' . intval($isFound));
570 if ($isFound === true) {
571 // Shall we skip this entry?
572 if ($searchInstance->getSkip() > 0) {
573 // We shall skip some entries
574 if ($skipFound < $searchInstance->getSkip()) {
576 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: Found entry, but skipping ...');
582 // Entry found, so update it
583 foreach ($searchArray as $searchKey => $searchValue) {
584 // Make sure the value is not bool again
585 assert(!is_bool($searchValue));
586 assert($searchKey != $this->indexKey);
588 // Debug message + add/update it
589 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: criteriaKey=' . $searchKey . ',criteriaValue=' . $searchValue);
590 $dataArray[$searchKey] = $searchValue;
593 // Write the data to a local file
594 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: Writing dataArray()=' . count($dataArray) . ' to ' . $fileInfoInstance->getPathname() . ' ...');
595 $this->writeDataArrayToFqfn($fileInfoInstance, $dataArray);
597 // Count found entries up
602 // Advance to next entry
603 $directoryInstance->getDirectoryIteratorInstance()->next();
606 // Close the file pointer
607 $directoryInstance->closeDirectory();
609 // Update the primary key
610 $this->updatePrimaryKey($dataSetInstance);
612 // Reset last exception
613 $this->resetLastException();
614 } catch (FrameworkException $e) {
615 // Catch all exceptions and store them in last error
616 $this->setLastException($e);
618 // Throw an SQL exception
619 throw new SqlException(array($this, sprintf('Cannot write data to table '%s', is the table created? Exception: %s, message:%s', $dataSetInstance->getTableName(), $e->__toString(), $e->getMessage()), self::DB_CODE_TABLE_UNWRITEABLE), self::EXCEPTION_SQL_QUERY);
624 * Getter for primary key of specified table or if not found null will be
625 * returned. This must be database-specific.
627 * @param $tableName Name of the table we need the primary key from
628 * @return $primaryKey Primary key column of the given table
629 * @todo Rename method to getPrimaryKeyFromTableInfo()
631 public function getPrimaryKeyOfTable ($tableName) {
632 // Default key is null
635 // Does the table information exist?
636 if (isset($this->tableInfo[$tableName])) {
637 // Then return the primary key
638 $primaryKey = $this->tableInfo[$tableName]['primary'];
646 * Removes non-public data from given array.
648 * @param $data An array with possible non-public data that needs to be removed.
649 * @return $data A cleaned up array with only public data.
650 * @todo Add more generic non-public data for removal
652 public function removeNonPublicDataFromArray (array $data) {
654 unset($data[$this->indexKey]);
657 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: data[' . gettype($data) . ']='.print_r($data, true));
662 * Counts total rows of given table
664 * @param $tableName Table name
665 * @return $count Total rows of given table
667 public function countTotalRows($tableName) {
668 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: tableName=' . $tableName . ' - CALLED!');
670 // Create full path name
671 $pathName = $this->getConfigInstance()->getConfigEntry('local_database_path') . $tableName . DIRECTORY_SEPARATOR;
673 // Try all the requests
675 // Get a file pointer instance
676 $directoryInstance = ObjectFactory::createObjectByConfiguredName('directory_class', array($pathName));
678 // Initialize counter
681 // Read the directory with some exceptions
682 while ($fileInfoInstance = $directoryInstance->readDirectoryExcept(array('.htaccess', 'info.' . $this->getFileExtension()))) {
683 // Does the extension match?
684 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: fileInfoInstance->extension=' . $fileInfoInstance->getExtension() . ',this->getFileExtension()=' . $this->getFileExtension());
685 if ($fileInfoInstance->getExtension() !== $this->getFileExtension()) {
687 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: fileInfoInstance.extension=' . $fileInfoInstance->getExtension() . ',getFileExtension()=' . $this->getFileExtension() . ' - SKIPPED!');
693 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: fileInfoInstance.pathname=' . $fileInfoInstance->getPathname() . ',getFileExtension()=' . $this->getFileExtension() . ' - COUNTED!');
696 } catch (FrameworkException $e) {
697 // Catch all exceptions and store them in last error
698 $this->setLastException($e);
700 // Throw an SQL exception
701 throw new SqlException(array($this, sprintf('Cannot count on table '%s', is the table created?', $dataSetInstance->getTableName()), self::DB_CODE_TABLE_NOT_FOUND), self::EXCEPTION_SQL_QUERY);
705 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-LFDB: tableName=' . $tableName . ',count=' . $count . ' - EXIT!');