/**
* A general crtieria class
*
- * @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 - 2012 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 $wrapperConfigEntry = '';
- /**
- * Criteria to handle
- */
- private $criteria = array(
- // Default
- 'default' => array(),
- // Choice
- 'choice' => array(),
- // .. and exclude
- 'exclude' => array(),
- );
-
/**
* Protected constructor
*
protected function __construct ($className) {
// Call parent constructor
parent::__construct($className);
+
+ // Initialize all criteria arrays
+ foreach (array('default', 'choice', 'exclude') as $criteriaType) {
+ // Init it
+ $this->initGenericArrayKey('criteria', $criteriaType, 'entries');
+ } // END - foreach
+ }
+
+ /**
+ * Checks whether given key is set
+ *
+ * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude'
+ * @param $criteriaKey Criteria key
+ * @return $isSet Whether key is set
+ */
+ public function isKeySet ($criteriaType, $criteriaKey) {
+ // Make sure no 'my-' or 'my_' passes this point
+ assert((strpos($criteriaKey, 'my-') === FALSE) && (strpos($criteriaKey, 'my_') === FALSE));
+
+ // Determine it
+ $isSet = $this->isGenericArrayElementSet('criteria', $criteriaType, 'entries', $criteriaKey);
+
+ // Return it
+ return $isSet;
+ }
+
+ /**
+ * Checks whether given key is set for 'choice' type
+ *
+ * @param $criteriaKey Criteria key
+ * @return $isSet Whether key is set
+ */
+ public function isChoiceKeySet ($criteriaKey) {
+ // Call inner method
+ return $this->isKeySet('choice', $criteriaKey);
+ }
+
+ /**
+ * Checks whether given key is set for 'exclude' type
+ *
+ * @param $criteriaKey Criteria key
+ * @return $isSet Whether key is set
+ */
+ public function isExcludeKeySet ($criteriaKey) {
+ // Call inner method
+ return $this->isKeySet('exclude', $criteriaKey);
}
/**
* @return $criteria
*/
public final function getCriteriaArray ($criteriaType = 'default') {
- return $this->criteria[$criteriaType];
+ return $this->getGenericArrayKey('criteria', $criteriaType, 'entries');
}
/**
return $this->getCriteriaArray('exclude');
}
+ /**
+ * Unsets a criteria key from all criteria types
+ *
+ * @param $criteriaKey Criteria key to unset
+ * @return void
+ */
+ public final function unsetCriteria ($criteriaKey) {
+ // Make sure no 'my-' or 'my_' passes this point
+ assert((strpos($criteriaKey, 'my-') === FALSE) && (strpos($criteriaKey, 'my_') === FALSE));
+
+ // Convert dashes to underscore
+ $criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
+
+ // "Walk" through all criterias
+ foreach ($this->getGenericArray('criteria') as $criteriaType => $dummy) {
+ // Remove it
+ $this->unsetGenericArrayElement('criteria', $criteriaType, 'entries', $criteriaKey);
+ } // END - foreach
+ }
+
/**
* Add criteria, this method converts dashes to underscores because dashes
* are not valid for criteria keys.
* @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude'
* @return void
*/
- public final function addCriteria ($criteriaKey, $criteriaValue, $criteriaType = 'default') {
- // Debug message
- if (strpos($criteriaKey, 'my-') !== false) $this->debugBackTrace('criteriaKey=' . $criteriaKey);
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '-CRITERIA: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue);
+ public function addCriteria ($criteriaKey, $criteriaValue, $criteriaType = 'default') {
+ // Make sure no 'my-' or 'my_' passes this point
+ assert((strpos($criteriaKey, 'my-') === FALSE) && (strpos($criteriaKey, 'my_') === FALSE) && (!is_bool($criteriaValue)));
// Convert dashes to underscore
$criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
- // Is it already there?
- if (isset($this->criteria[$criteriaType][$criteriaKey])) {
- // Append it
- $this->criteria[$criteriaType][$criteriaKey] .= ',' . $criteriaValue;
- } else {
- // Add it
- $this->criteria[$criteriaType][$criteriaKey] = (string) $criteriaValue;
- }
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue);
+
+ // Append it
+ $this->appendStringToGenericArrayElement('criteria', $criteriaType, 'entries', $criteriaKey, $criteriaValue);
}
/**
* @return void
*/
public final function addChoiceCriteria ($criteriaKey, $criteriaValue) {
+ // Make sure no 'my-' or 'my_' passes this point
+ assert((strpos($criteriaKey, 'my-') === FALSE) && (strpos($criteriaKey, 'my_') === FALSE) && (!is_bool($criteriaValue)));
+
// Debug message
- if (strpos($criteriaKey, 'my-') !== false) $this->debugBackTrace('criteriaKey=' . $criteriaKey);
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHOICE-CRITERIA: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue);
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue);
// Add it
- $this->criteria['choice'][$this->convertDashesToUnderscores($criteriaKey)][] = (string) $criteriaValue;
+ $this->pushValueToGenericArrayElement('criteria', 'choice', 'entries', $this->convertDashesToUnderscores($criteriaKey), (string) $criteriaValue);
}
/**
}
/**
- * Get criteria element or null if not found
+ * Get criteria element or FALSE if not found
*
* @param $criteriaKey The requested criteria key
* @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude'
- * @return $value Whether the value of the critera or null
+ * @return $value Whether the value of the critera or FALSE
*/
public function getCriteriaElemnent ($criteriaKey, $criteriaType = 'default') {
+ // Make sure no 'my-' or 'my_' passes this point
+ assert((strpos($criteriaKey, 'my-') === FALSE) && (strpos($criteriaKey, 'my_') === FALSE));
+
// Convert dashes to underscore
$criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
// Debug message
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CRITERIA: criteriaKey=' . $criteriaKey . ',criteria()=' . count($this->criteria[$criteriaType]));
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteria()=' . $this->countGenericArrayGroup('criteria', $criteriaType)));
// Default is not found
- $value = NULL;
+ $value = FALSE;
// Is the criteria there?
- if (isset($this->criteria[$criteriaType][$criteriaKey])) {
+ if ($this->isKeySet($criteriaType, $criteriaKey)) {
// Then use it
- $value = $this->criteria[$criteriaType][$criteriaKey];
+ $value = $this->getGenericArrayElement('criteria', $criteriaType, 'entries', $criteriaKey);
} // END - if
// Return the value
}
/**
- * Get criteria element or null if not found for 'choice' type
+ * Get criteria element or FALSE if not found for 'choice' type
*
* @param $criteriaKey The requested criteria key
- * @return $value Whether the value of the critera or null
+ * @return $value Whether the value of the critera or FALSE
*/
public function getCriteriaChoiceElemnent ($criteriaKey) {
// Call inner method
}
/**
- * Get criteria element or null if not found for 'exclude' type
+ * Get criteria element or FALSE if not found for 'exclude' type
*
* @param $criteriaKey The requested criteria key
- * @return $value Whether the value of the critera or null
+ * @return $value Whether the value of the critera or FALSE
*/
public function getCriteriaExcludeElemnent ($criteriaKey) {
// Call inner method
*/
public function ifEntryMatches (array $entryArray, $criteriaType = 'default') {
// First nothing matches and nothing is counted
- $matches = false;
+ $matches = FALSE;
$counted = 0;
// Walk through all entries
foreach ($entryArray as $key => $entry) {
+ // Make sure no 'my-' or 'my_' passes this point
+ assert((strpos($key, 'my-') === FALSE) && (strpos($key, 'my_') === FALSE));
+
// Convert dashes to underscore
$key = $this->convertDashesToUnderscores($key);
// Then walk through all search criteria
- foreach ($this->criteria[$criteriaType] as $criteriaKey => $criteriaValue) {
+ foreach ($this->getGenericArrayKey('criteria', $criteriaType, 'entries') as $criteriaKey => $criteriaValue) {
+ // Make sure no 'my-' or 'my_' passes this point
+ assert((strpos($criteriaKey, 'my-') === FALSE) && (strpos($criteriaKey, 'my_') === FALSE) && (!is_bool($criteriaValue)));
+
// Convert dashes to underscore
$criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
} // END - foreach
// Now check if expected criteria counts match
- $matches = ($counted == count($this->criteria[$criteriaType]));
+ $matches = ($counted == $this->countGenericArrayGroup('criteria', $criteriaType));
// Return the result
return $matches;
*/
public function getCacheKey ($onlyKeys = array(), $criteriaType = 'default') {
// Debug message
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': criteriaType=' . $criteriaType . ',count()=' . count($this->criteria));
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': criteriaType=' . $criteriaType . ',count()=' . $this->countGenericArray('criteria')));
// Make sure the criteria is there
- assert((isset($this->criteria[$criteriaType])) && (is_array($this->criteria[$criteriaType])));
+ assert($this->isValidGenericArrayGroup('criteria', $criteriaType));
// Initialize the key
$cacheKey = '';
// Now walk through all criterias
- foreach ($this->criteria[$criteriaType] as $criteriaKey => $criteriaValue) {
+ foreach ($this->getGenericArrayKey('criteria', $criteriaType, 'entries') as $criteriaKey => $criteriaValue) {
+ // Make sure no 'my-' or 'my_' passes this point
+ assert((strpos($criteriaKey, 'my-') === FALSE) && (strpos($criteriaKey, 'my_') === FALSE) && (!is_bool($criteriaValue)));
+
+ // $criteriaValue cannot be an array
+ assert(!is_array($criteriaValue));
+
// Convert dashes to underscore
$criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
// Is the value in array or is $onlyKeys empty?
if ((isset($onlyKeys[$criteriaKey])) || (count($onlyKeys) == 0)) {
// Add the value URL encoded to avoid any trouble with special characters
- $cacheKey .= sprintf("%s=%s;",
+ $cacheKey .= sprintf('%s=%s;',
$criteriaKey,
urlencode($criteriaValue)
);
// Check if 'limit' and 'skip' are in
if (((isset($onlyKeys['limit'])) && (isset($onlyKeys['skip']))) || (count($onlyKeys) == 0)) {
// Add limit and skip values
- $cacheKey .= sprintf(";%%limit%%=%s;%%skip%%=%s",
+ $cacheKey .= sprintf(';%%limit%%=%s;%%skip%%=%s',
$this->getLimit(),
$this->getSkip()
);
*/
public final function count ($criteriaType = 'default') {
// Return it
- return count($this->criteria[$criteriaType]);
+ return $this->countGenericArrayGroup('criteria', $criteriaType);
}
/**
projects / core.git / blobdiff