/**
* An interface for criterias
*
- * @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
*/
function getWrapperConfigEntry ();
+ /**
+ * 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
+ */
+ function isKeySet ($criteriaType, $criteriaKey);
+
+ /**
+ * Checks whether given key is set for 'choice' type
+ *
+ * @param $criteriaKey Criteria key
+ * @return $isSet Whether key is set
+ */
+ function isChoiceKeySet ($criteriaKey);
+
+ /**
+ * Checks whether given key is set for 'exclude' type
+ *
+ * @param $criteriaKey Criteria key
+ * @return $isSet Whether key is set
+ */
+ function isExcludeKeySet ($criteriaKey);
+
/**
* Getter for criteria array
*
*/
function getCriteriaExcludeArray ();
+ /**
+ * Unsets a criteria key from all criteria types
+ *
+ * @param $criteriaKey Criteria key to unset
+ * @return void
+ */
+ function unsetCriteria ($criteriaKey);
+
/**
* Add criteria, this method converts dashes to underscores because dashes
* are not valid for criteria keys.
*/
function addCriteria ($criteriaKey, $criteriaValue, $criteriaType = 'default');
+ /**
+ * Sets criteria, this method converts dashes to underscores because dashes
+ * are not valid for criteria keys.
+ *
+ * @param $criteriaKey Criteria key
+ * @param $criteriaValue Criteria value
+ * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude'
+ * @return void
+ */
+ function setCriteria ($criteriaKey, $criteriaValue, $criteriaType = 'default');
+
/**
* Add "choice" criteria, this method converts dashes to underscores because
* dashes are not valid for criteria keys.
function addConfiguredCriteria ($criteriaKey, $configEntry, $criteriaType = 'default');
/**
- * 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
*/
function getCriteriaElemnent ($criteriaKey, $criteriaType = 'default');
+ /**
+ * 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 FALSE
+ */
+ function getCriteriaChoiceElemnent ($criteriaKey);
+
+ /**
+ * 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 FALSE
+ */
+ function getCriteriaExcludeElemnent ($criteriaKey);
+
/**
* Checks whether given array entry matches
*
*/
function getCacheKeyExclude ($onlyKeys = array());
- /**
- * "Getter" for a cache key ('choice' type)
- *
- * @param $onlyKeys Only use these keys for a cache key
- * @return $cacheKey The key suitable for the cache system
- */
- function getCacheKeyChoice ($onlyKeys = array());
-
/**
* Count the criteria, e.g. useful to find out if a database query has no
* limitation (search criteria).