/**
* A set of data storeable in databases
*
- * @see DatabaseFrontendInterface - An interface for database frontends (front-end to the application)
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*/
private $tableName = '';
- /**
- * Table columns (criteria) to store
- */
- private $tableColumns = array();
-
/**
* Unique key
*/
*/
private $primaryKey = '';
+ /**
+ * Primary keys
+ */
+ private $primaryKeys = array();
+
/**
* Protected constructor
*
* @return void
*/
- protected function __construct() {
+ protected function __construct () {
// Call parent constructor
parent::__construct(__CLASS__);
}
* @param $tableName Name of the table
* @return $criteriaInstance An instance of this criteria
*/
- public final static function createDataSetCriteria ($tableName) {
+ public static final function createDataSetCriteria ($tableName) {
// Get a new instance
$criteriaInstance = new DataSetCriteria();
return $criteriaInstance;
}
- /**
- * Add criteria
- *
- * @param $criteriaKey Criteria key
- * @param $criteriaValue Criteria value
- * @return void
- */
- public function addCriteria ($criteriaKey, $criteriaValue) {
- $this->tableColumns[(string) $criteriaKey] = $criteriaValue;
- }
-
- /**
- * Add configured criteria
- *
- * @param $criteriaKey Criteria key
- * @param $configEntry Configuration entry
- * @return void
- */
- public function addConfiguredCriteria ($criteriaKey, $configEntry) {
- // Add configuration entry as criteria
- $value = $this->getConfigInstance()->readConfig($configEntry);
- $this->addCriteria($criteriaKey, $value);
- }
-
/**
* Setter for table name
*
* @return $uniqueValue Value of the unique key
*/
public final function getUniqueValue () {
- return $this->tableColumns[$this->getUniqueKey()];
- }
-
- /**
- * Getter for criteria array
- *
- * @return $tableColumns
- */
- public final function getCriteriaArray () {
- return $this->tableColumns;
+ // Get primary key(s) first
+ $primaryKey = trim($this->getCriteriaElemnent($this->getPrimaryKey()));
+ $primaryKeys = $this->getPrimaryKeys();
+
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: tableName=' . $this->getTableName() . ',primaryKey=' . $primaryKey . ',primaryKeys()=' . count($primaryKeys));
+
+ /*
+ * If this is not set, this could mean a badly written frontend as
+ * tables should always have a primary key.
+ */
+ if (count($primaryKeys) > 0) {
+ /*
+ * Init return value, this can be put all together without any
+ * separator as it only aids as a "unique value" for generating the
+ * "row file name".
+ */
+ $return = '';
+
+ // Combination set, so get all
+ foreach ($primaryKeys as $primaryKey) {
+ // Add it
+ $return .= trim($this->getCriteriaElemnent($primaryKey));
+ } // END - foreach
+
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: tableName=' . $this->getTableName() . ',return=' . $return . ' - EXIT!');
+
+ // Return it
+ return $return;
+ } elseif (!empty($primaryKey)) {
+ // Return primary key
+ return $primaryKey;
+ } else {
+ // @TODO Issue a warning
+ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: Primary key not set for table ' . $this->getTableName() . ', please fix your table. Falling back to unique key ...');
+
+ // Get unique key
+ $uniqueKey = trim($this->getCriteriaElemnent($this->getUniqueKey()));
+
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: tableName=' . $this->getTableName() . ',uniqueKey=' . $uniqueKey);
+
+ // Is it empty, too?
+ if (empty($uniqueKey)) {
+ // Bad news, nothing is "unique" by design for this table
+ ApplicationEntryPoint::app_exit('Table ' . $this->getTableName() . ' has both no primary and unique key, but ' . __METHOD__ . ' was called. Please fix your table.');
+ } else {
+ // Return unique key
+ return $uniqueKey;
+ }
+ }
}
/**
public final function setPrimaryKey ($primaryKey) {
$this->primaryKey = (string) $primaryKey;
}
+
+ /**
+ * Setter for primary key array
+ *
+ * @param $primaryKeys Primary key array to set
+ * @return void
+ */
+ public function setPrimaryKeyCombined (array $primaryKeys) {
+ $this->primaryKeys = $primaryKeys;
+ }
+
+ /**
+ * Getter for primary keys
+ *
+ * @return $primaryKeys Primary key array
+ */
+ public final function getPrimaryKeys () {
+ // Return it
+ return $this->primaryKeys;
+ }
}
// [EOF]