X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=framework%2Fmain%2Fclasses%2Fcriteria%2Fsearch%2Fclass_SearchCriteria.php;h=7234fb23166c6e9bd86d669c98affac39eebd4e2;hb=HEAD;hp=e6f71ea23fffebb7fac2ff3406d5b7aabc55c4f2;hpb=146c8b3c929a1b0ab17d6605e5ae949ac44899c1;p=core.git

diff --git a/framework/main/classes/criteria/search/class_SearchCriteria.php b/framework/main/classes/criteria/search/class_SearchCriteria.php
index e6f71ea2..7234fb23 100644
--- a/framework/main/classes/criteria/search/class_SearchCriteria.php
+++ b/framework/main/classes/criteria/search/class_SearchCriteria.php
@@ -1,10 +1,16 @@
 <?php
 // Own namespace
-namespace CoreFramework\Criteria\Search;
+namespace Org\Mxchange\CoreFramework\Criteria\Search;
 
 // Import framework stuff
-use CoreFramework\Criteria\BaseCriteria;
-use CoreFramework\Criteria\Local\LocalSearchCriteria;
+use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
+use Org\Mxchange\CoreFramework\Criteria\BaseCriteria;
+use Org\Mxchange\CoreFramework\Criteria\Local\LocalSearchCriteria;
+use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
+
+// Import SPL stuff
+use \InvalidArgumentException;
+use \UnexpectedValueException;
 
 /**
  * Search criteria for e.g. searching in databases. Do not use this class if
@@ -13,7 +19,7 @@ use CoreFramework\Criteria\Local\LocalSearchCriteria;
  *
  * @author		Roland Haeder <webmaster@shipsimu.org>
  * @version		0.0.0
- * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  * @license		GNU GPL 3.0 or any newer version
  * @link		http://www.shipsimu.org
  *
@@ -34,7 +40,7 @@ class SearchCriteria extends BaseCriteria implements LocalSearchCriteria {
 	/**
 	 * Criteria to handle
 	 */
-	private $criteria = array();
+	private $criteria = [];
 
 	/**
 	 * Limitation for the search
@@ -51,7 +57,7 @@ class SearchCriteria extends BaseCriteria implements LocalSearchCriteria {
 	 *
 	 * @return	void
 	 */
-	protected function __construct () {
+	private function __construct () {
 		// Call parent constructor
 		parent::__construct(__CLASS__);
 	}
@@ -63,9 +69,11 @@ class SearchCriteria extends BaseCriteria implements LocalSearchCriteria {
 	 */
 	public static final function createSearchCriteria () {
 		// Get a new instance
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('SEARCH-CRITERIA: CALLED!');
 		$criteriaInstance = new SearchCriteria();
 
 		// Return this instance
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('SEARCH-CRITERIA: criteriaInstance=%s - EXIT!', $criteriaInstance->__toString()));
 		return $criteriaInstance;
 	}
 
@@ -76,20 +84,34 @@ class SearchCriteria extends BaseCriteria implements LocalSearchCriteria {
 	 * @return	void
 	 * @todo	Find a nice casting here. (int) allows until and including 32766.
 	 */
-	public final function setLimit ($limit) {
+	public final function setLimit (int $limit) {
 		$this->limit = $limit;
 	}
 
 	/**
 	 * "Setter" for limit from a configuration entry
 	 *
-	 * @param	$configEntry	The configuration entry which hold a number as limit
+	 * @param	$configKey	The configuration entry which hold a number as limit
 	 * @return	void
+	 * @throws	InvalidArgumentException	If a paramter has an invalid value
 	 */
-	public final function setConfiguredLimit ($configEntry) {
-		// Get the limit from config entry and set it
-		$limit = $this->getConfigInstance()->getConfigEntry($configEntry);
+	public final function setConfiguredLimit (string $configKey) {
+		// Check parameter
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('SEARCH-CRITERIA: configKey=%s - CALLED!', $configKey));
+		if (empty($configKey)) {
+			// Throw IAE
+			throw new InvalidArgumentException('Parameter "configKey" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
+		}
+
+		// Get the limit from config entry
+		$limit = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($configKey);
+
+		// And set it
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('SEARCH-CRITERIA: limit=%d', $limit));
 		$this->setLimit($limit);
+
+		// Trace message
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('SEARCH-CRITERIA: EXIT!');
 	}
 
 	/**
@@ -108,7 +130,7 @@ class SearchCriteria extends BaseCriteria implements LocalSearchCriteria {
 	 * @return	void
 	 * @todo	Find a nice casting here. (int) allows until and including 32766.
 	 */
-	public final function setSkip ($skip) {
+	public final function setSkip (int $skip) {
 		$this->skip = $skip;
 	}
 
@@ -129,81 +151,101 @@ class SearchCriteria extends BaseCriteria implements LocalSearchCriteria {
 	 * @param	$value			Value to check
 	 * @param	$separator		Separator for "exploding" $value (default: ',')
 	 * @return	$isMatching		Whether the key/value is matching or excluded
+	 * @throws	InvalidArgumentException	If a parameter is invalid
+	 * @throws	UnexpectedValueException	If $searchChoice is not an array
 	 */
-	public function isCriteriaMatching ($key, $value, $separator = ',') {
+	public function isCriteriaMatching (string $key, $value, string $separator = ',') {
 		// $key/$value cannot be array/NULL/bool, value can be NULL but then NULL must be loocked for
-		assert((!is_array($value)) && (!is_bool($value)) && (!is_array($key)) && (!is_null($key)) && (!is_bool($key)));
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('SEARCH-CRITERIA: key=%s,value[]=%s,separator=%s - CALLED!', $key, gettype($value), $separator));
+		if (empty($key)) {
+			// Throw IAE
+			throw new InvalidArgumentException('Parameter "key" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
+		} elseif (is_array($value) || is_bool($value) || is_object($value) || is_resource($value)) {
+			// Throw it again
+			throw new InvalidArgumentException(sprintf('value[]=%s is not supported/valid', gettype($value)));
+		} elseif (empty($separator)) {
+			// Throw IAE
+			throw new InvalidArgumentException('Parameter "separator" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
+		}
 
 		// "Explode" value
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('SEARCH-CRITERIA: Invoking explode("%s",value[]=%s) ...', $separator, gettype($value)));
 		$valueArray = explode($separator, $value);
-
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: key=' . $key . ',value[' . gettype($value) . ']=' . $value . ' - CALLED!');
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: valueArray()=%d', count($valueArray)));
 
 		// Get 'default' search value
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('SEARCH-CRITERIA: Invoking this->getCriteriaElemnent(%s) ...', $key));
 		$searchDefault = $this->getCriteriaElemnent($key);
 
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaElement(' . $key . ')[' . gettype($searchDefault) . ']=' . $searchDefault);
-
 		// 'default' check
-		$isMatching = (((($searchDefault !== false) && ($searchDefault == $value)) || ((is_null($searchDefault)) && (is_null($value)))) || ($searchDefault === false));
-
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaElement(' . $key . ')[' . gettype($searchDefault) . ']=' . $searchDefault . ',isMatching=' . intval($isMatching));
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: searchDefault[%s]=%s', gettype($searchDefault), $searchDefault));
+		$isMatching = (
+			(
+				(
+					($searchDefault !== false) &&
+					($searchDefault == $value)
+				) || (
+					is_null($searchDefault) &&
+					is_null($value)
+				)
+			) || (
+				$searchDefault === false
+			)
+		);
 
 		// Get 'choice' search value (can be NULL or $separator-separated string)
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: isMatching=%d', intval($isMatching)));
 		$searchChoice = $this->getCriteriaChoiceElemnent($key);
 
-		// May be false or array
-		assert(($searchChoice === false) || (is_array($searchChoice)));
-
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[' . gettype($searchChoice) . ']=' . print_r($searchChoice, true));
+		// Is an array returned?
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: searchChoice[]=%s', gettype($searchChoice)));
+		if (!is_array($searchChoice) && !is_bool($searchChoice)) {
+			// Should not happen
+			throw new UnexpectedValueException(sprintf('searchChoice[]=%s is unexpected', gettype($searchChoice)), FrameworkInterface::EXCEPTION_UNEXPECTED_VALUE);
+		}
 
 		// 'choice' check
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: searchChoice[]=%s', gettype($searchChoice)));
 		if ((is_array($searchChoice)) && (count($valueArray) == 1)) {
-			// $value is a single-search value, so use in_array()
+			// $value is a single-search value, so use in_[]
 			$isMatching = ((($isMatching === true) || (($searchDefault === false) && (!is_null($value)))) && (in_array($value, $searchChoice)));
 
 			// Debug message
-			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',value[' . gettype($value) . ']=' . $value . ',isMatching=' . intval($isMatching) . ' - SINGLE-MATCH');
+			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: isMatching=%d - SINGLE-MATCH', intval($isMatching)));
 		} elseif ((is_array($searchChoice)) && (count($valueArray) > 1)) {
-			// Debug message
-			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',valueArray()=' . count($valueArray) . ',isMatching=' . intval($isMatching));
-
 			// $value is choice-search value, so check all entries
+			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: searchChoice()=%d,valueArray()=%d - MULTI-MATCH', count($searchChoice), count($valueArray)));
 			$isMatching = (($isMatching === true) || (($searchDefault === false) && (!is_null($value))));
-			$idx = 0;
-			foreach ($valueArray as $idx => $match) {
-				// Debug message
-				//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: match=' . $match . ',count(searchChoice)=' . count($searchChoice));
 
+			// Loop through all values
+			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: isMatching=%d - BEFORE!', intval($isMatching)));
+			foreach ($valueArray as $idx => $match) {
 				// Is it found? (one is okay)
+				//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: idx=%d,match=%s', $idx, $match));
 				$isMatching = (($isMatching === true) && (in_array($match, $searchChoice)));
 
-				// Debug message
-				//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: match=' . $match . ',isMatching=' . intval($isMatching));
-			} // END - foreach
+				// No longer matching?
+				//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: isMatching=%d - LOOP!', intval($isMatching)));
+				if (!$isMatching) {
+					// Skip further iterations
+					//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('SEARCH-CRITERIA: BREAK!');
+					break;
+				}
+			}
 
 			// Debug message
-			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',valueArray()=' . count($valueArray) . ',idx=' . $idx . ',isMatching=' . intval($isMatching) . ' - CHOICE-MATCH');
+			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: isMatching=%d - AFTER!', intval($isMatching)));
 		} else {
 			// Choice-match is false
-			// Debug message
-			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',value[' . gettype($value) . ']=' . $value . ',isMatching=' . intval($isMatching) . ' - false-MATCH');
+			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: key=%s[],searchChoice[]=%s,value[%s]=%s,isMatching=%d - FALSE-MATCH', $key, gettype($searchChoice), gettype($value), $value, intval($isMatching)));
 		}
 
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaChoiceElement(' . $key . ')[]=' . gettype($searchChoice) . ',isMatching=' . intval($isMatching));
-
 		// Get 'exclude' search value
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: Invoking this->getCriteriaExcludeElemnent(%s) ...', $key));
 		$searchExclude = $this->getCriteriaExcludeElemnent($key);
 
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: getCriteriaExcludeElement(' . $key . ')[' . gettype($searchExclude) . ']=' . $searchExclude);
-
 		// 'exclude' check
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('SEARCH-CRITERIA: searchExclude[%s]=%s', gettype($searchExclude), $searchExclude));
 		$isMatching = (
 			(
 				(
@@ -225,7 +267,7 @@ class SearchCriteria extends BaseCriteria implements LocalSearchCriteria {
 		);
 
 		// Return result
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('SEARCH-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: key=' . $key . ',value[' . gettype($value) . ']=' . $value . ',isMatching=' . intval($isMatching) . ' - EXIT!');
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('SEARCH-CRITERIA: isMatching=%d - EXIT!', intval($isMatching)));
 		return $isMatching;
 	}