X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fcriteria%2Fclass_BaseCriteria.php;h=dfa0d4ee7879f7291884ee15b3f220b126df3a93;hp=55636c6166ebecf0295e308145c87b6180020600;hb=89f25725096fa51850e2d4d0a2ed57906c0b23e0;hpb=607a11e2c22949ea0647568c17d62a605595e83b diff --git a/inc/classes/main/criteria/class_BaseCriteria.php b/inc/classes/main/criteria/class_BaseCriteria.php index 55636c61..dfa0d4ee 100644 --- a/inc/classes/main/criteria/class_BaseCriteria.php +++ b/inc/classes/main/criteria/class_BaseCriteria.php @@ -21,16 +21,12 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class BaseCriteria extends BaseFrameworkSystem { +class BaseCriteria extends BaseFrameworkSystem implements Criteria { /** * Wrapper class name stored in config entry */ private $wrapperConfigEntry = ''; - /** - * Criteria to handle - */ - private $criteria = array(); /** * Protected constructor * @@ -42,6 +38,46 @@ class BaseCriteria extends BaseFrameworkSystem { parent::__construct($className); } + /** + * 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->isGenericArrayKeySet('criteria', $criteriaType, $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); + } + /** * Setter for wrapper class name * @@ -64,21 +100,104 @@ class BaseCriteria extends BaseFrameworkSystem { /** * Getter for criteria array * + * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude' + * @return $criteria + */ + public final function getCriteriaArray ($criteriaType = 'default') { + return $this->getGenericSubArray('criteria', $criteriaType); + } + + /** + * Getter for criteria array 'choice' type + * * @return $criteria */ - public final function getCriteriaArray () { - return $this->criteria; + public final function getCriteriaChoiceArray () { + return $this->getCriteriaArray('choice'); } /** - * Add criteria + * Getter for criteria array 'exclude' type + * + * @return $criteria + */ + public final function getCriteriaExcludeArray () { + 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, $criteriaKey); + } // END - foreach + } + + /** + * Add 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 + */ + public final 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); + + // Debug message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue); + + // Append it + $this->appendStringToGenericArrayElement('criteria', $criteriaType, $criteriaKey, $criteriaValue); + } + + /** + * Add "choice" criteria, this method converts dashes to underscores because + * dashes are not valid for criteria keys. + * + * @param $criteriaKey Criteria key + * @param $criteriaValue Criteria value + * @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 + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue); + + // Add it + $this->pushValueToGenericArrayElement('criteria', 'choice', $this->convertDashesToUnderscores($criteriaKey), (string) $criteriaValue); + } + + /** + * Add "exclude" criteria, this method converts dashes to underscores because + * dashes are not valid for criteria keys. * * @param $criteriaKey Criteria key * @param $criteriaValue Criteria value * @return void */ - public final function addCriteria ($criteriaKey, $criteriaValue) { - $this->criteria[(string)$criteriaKey] = (string)$criteriaValue; + public final function addExcludeCriteria ($criteriaKey, $criteriaValue) { + // Add it with generic method + $this->addCriteria($criteriaKey, $criteriaValue, 'exclude'); } /** @@ -86,49 +205,95 @@ class BaseCriteria extends BaseFrameworkSystem { * * @param $criteriaKey Criteria key * @param $configEntry Configuration entry + * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude' * @return void */ - public final function addConfiguredCriteria ($criteriaKey, $configEntry) { + public final function addConfiguredCriteria ($criteriaKey, $configEntry, $criteriaType = 'default') { // Add the configuration entry as a criteria $value = $this->getConfigInstance()->getConfigEntry($configEntry); - $this->addCriteria($criteriaKey, $value); + $this->addCriteria($criteriaKey, $value, $criteriaType); } /** - * Get criteria element or null if not found + * Get criteria element or FALSE if not found * - * @param $criteria The criteria we want to have - * @return $value Whether the value of the critera or null + * @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 FALSE */ - public function getCriteriaElemnent ($criteria) { + 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(strtoupper($criteriaType) . '-CRITERIA[' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteria()=' . $this->countGenericArrayGroup('criteria', $criteriaType))); + // Default is not found - $value = NULL; + $value = FALSE; // Is the criteria there? - if (isset($this->criteria[$criteria])) { + if ($this->isKeySet($criteriaType, $criteriaKey)) { // Then use it - $value = $this->criteria[$criteria]; - } + $value = $this->getGenericArrayKey('criteria', $criteriaType, $criteriaKey); + } // END - if // Return the value return $value; } + /** + * 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 + */ + public function getCriteriaChoiceElemnent ($criteriaKey) { + // Call inner method + return $this->getCriteriaElemnent($criteriaKey, 'choice'); + } + + /** + * 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 + */ + public function getCriteriaExcludeElemnent ($criteriaKey) { + // Call inner method + return $this->getCriteriaElemnent($criteriaKey, 'exclude'); + } + /** * Checks whether given array entry matches * * @param $entryArray Array with the entries to find + * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude' * @return $matches Whether the entry matches or not */ - public function ifEntryMatches (array $entryArray) { + 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 as $criteriaKey => $criteriaValue) { + foreach ($this->getGenericSubArray('criteria', $criteriaType) 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); + // Is the element found and does it match? if (($key == $criteriaKey) && ($criteriaValue == $entry)) { // Then count this one up @@ -138,24 +303,59 @@ class BaseCriteria extends BaseFrameworkSystem { } // END - foreach // Now check if expected criteria counts match - $matches = ($counted == count($this->criteria)); + $matches = ($counted == $this->countGenericArrayGroup('criteria', $criteriaType))); // Return the result return $matches; } + /** + * Checks whether given array 'choice' entry matches + * + * @param $entryArray Array with the entries to find + * @return $matches Whether the entry matches or not + */ + public function ifChoiceMatches (array $entryArray) { + // Call inner method + return $this->ifEntryMatches($entryArray, 'choice'); + } + + /** + * Checks whether given array 'exclude' entry matches + * + * @param $entryArray Array with the entries to find + * @return $matches Whether the entry matches or not + */ + public function ifExcludeMatches (array $entryArray) { + // Call inner method + return $this->ifEntryMatches($entryArray, 'exclude'); + } + /** * "Getter" for a cache key * * @param $onlyKeys Only use these keys for a cache key + * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude' * @return $cacheKey The key suitable for the cache system */ - public function getCacheKey ($onlyKeys = array()) { + public function getCacheKey ($onlyKeys = array(), $criteriaType = 'default') { + // Debug message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': criteriaType=' . $criteriaType . ',count()=' . $this->countGenericArray('criteria'))); + + // Make sure the criteria is there + assert($this->isValidGenericArrayGroup('criteria', $criteriaType)); + // Initialize the key $cacheKey = ''; // Now walk through all criterias - foreach ($this->criteria as $criteriaKey => $criteriaValue) { + foreach ($this->getGenericSubArray('criteria', $criteriaType) 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); + // 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 @@ -184,6 +384,60 @@ class BaseCriteria extends BaseFrameworkSystem { // Return the cache key return $cacheKey; } + + /** + * "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 + */ + public function getCacheKeyChoice ($onlyKeys = array()) { + // Call inner method + return $this->getCacheKey($onlyKeys, 'choice'); + } + + /** + * "Getter" for a cache key ('exclude' type) + * + * @param $onlyKeys Only use these keys for a cache key + * @return $cacheKey The key suitable for the cache system + */ + public function getCacheKeyExclude ($onlyKeys = array()) { + // Call inner method + return $this->getCacheKey($onlyKeys, 'exclude'); + } + + /** + * Count the criteria, e.g. useful to find out if a database query has no + * limitation (search criteria). + * + * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude' + * @return $count Count of all criteria entries + */ + public final function count ($criteriaType = 'default') { + // Return it + return $this->countGenericArrayGroup('criteria', $criteriaType)); + } + + /** + * Count 'choice' criteria, e.g. useful to find out if a database query + * has no limitation (search criteria). + * + * @return $count Count of all criteria entries + */ + public final function countChoice () { + return $this->count('choice'); + } + + /** + * Count 'exclude' criteria, e.g. useful to find out if a database query + * has no limitation (search criteria). + * + * @return $count Count of all criteria entries + */ + public final function countExclude () { + return $this->count('exclude'); + } } // [EOF]