X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=framework%2Fmain%2Fclasses%2Fcriteria%2Fclass_BaseCriteria.php;fp=framework%2Fmain%2Fclasses%2Fcriteria%2Fclass_BaseCriteria.php;h=c7aff1ed2ee04488262bae124816c5023ef9a00e;hb=498e6b065ce47804bff4e1073592a2cc8e28f8ef;hp=1073cbc4347d1550a4c3d25bfac17e8452389ec9;hpb=8a70226bd287a3f13b27932e2ec88d16c51c7e39;p=core.git diff --git a/framework/main/classes/criteria/class_BaseCriteria.php b/framework/main/classes/criteria/class_BaseCriteria.php index 1073cbc4..c7aff1ed 100644 --- a/framework/main/classes/criteria/class_BaseCriteria.php +++ b/framework/main/classes/criteria/class_BaseCriteria.php @@ -53,6 +53,18 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { } // END - foreach } + /** + * 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 + */ + protected final function count (string $criteriaType = 'default') { + // Return it + return $this->countGenericArrayGroup('criteria', $criteriaType); + } + /** * Checks whether given key is set * @@ -60,7 +72,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaKey Criteria key * @return $isSet Whether key is set */ - public function isKeySet ($criteriaType, $criteriaKey) { + public function isKeySet (string $criteriaType, string $criteriaKey) { // Make sure no 'my-' or 'my_' passes this point assert((strpos($criteriaKey, 'my-') === false) && (strpos($criteriaKey, 'my_') === false)); @@ -77,7 +89,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaKey Criteria key * @return $isSet Whether key is set */ - public function isChoiceKeySet ($criteriaKey) { + public function isChoiceKeySet (string $criteriaKey) { // Call inner method return $this->isKeySet('choice', $criteriaKey); } @@ -88,7 +100,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaKey Criteria key * @return $isSet Whether key is set */ - public function isExcludeKeySet ($criteriaKey) { + public function isExcludeKeySet (string $criteriaKey) { // Call inner method return $this->isKeySet('exclude', $criteriaKey); } @@ -99,8 +111,8 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $wrapperConfigEntry Configuration entry which hold the wrapper class' name * @return void */ - public final function setWrapperConfigEntry ($wrapperConfigEntry) { - $this->wrapperConfigEntry = (string) $wrapperConfigEntry; + public final function setWrapperConfigEntry (string $wrapperConfigEntry) { + $this->wrapperConfigEntry = $wrapperConfigEntry; } /** @@ -118,7 +130,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude' * @return $criteria */ - public final function getCriteriaArray ($criteriaType = 'default') { + public final function getCriteriaArray (string $criteriaType = 'default') { return $this->getGenericArrayKey('criteria', $criteriaType, 'entries'); } @@ -146,7 +158,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaKey Criteria key to unset * @return void */ - public final function unsetCriteria ($criteriaKey) { + public final function unsetCriteria (string $criteriaKey) { // Make sure no 'my-' or 'my_' passes this point assert((strpos($criteriaKey, 'my-') === false) && (strpos($criteriaKey, 'my_') === false)); @@ -169,7 +181,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @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') { + public final function addCriteria (string $criteriaKey, $criteriaValue, string $criteriaType = 'default') { // Debug message //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(strtoupper($criteriaType) . '-CRITERIA: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue . ',criteriaType=' . $criteriaType . ' - CALLED!'); @@ -195,7 +207,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude' * @return void */ - public final function setCriteria ($criteriaKey, $criteriaValue, $criteriaType = 'default') { + public final function setCriteria (string $criteriaKey, $criteriaValue, string $criteriaType = 'default') { // Debug message //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(strtoupper($criteriaType) . '-CRITERIA: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue . ',criteriaType=' . $criteriaType . ' - CALLED!'); @@ -220,7 +232,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaValue Criteria value * @return void */ - public final function addChoiceCriteria ($criteriaKey, $criteriaValue) { + public final function addChoiceCriteria (string $criteriaKey, $criteriaValue) { // Make sure no 'my-' or 'my_' passes this point assert((strpos($criteriaKey, 'my-') === false) && (strpos($criteriaKey, 'my_') === false) && (!is_bool($criteriaValue))); @@ -239,7 +251,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaValue Criteria value * @return void */ - public final function addExcludeCriteria ($criteriaKey, $criteriaValue) { + public final function addExcludeCriteria (string $criteriaKey, $criteriaValue) { // Add it with generic method $this->addCriteria($criteriaKey, $criteriaValue, 'exclude'); } @@ -252,7 +264,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaType Type of this criteria, can be one of 'default' (default), 'choice' or 'exclude' * @return void */ - public final function addConfiguredCriteria ($criteriaKey, $configEntry, $criteriaType = 'default') { + public final function addConfiguredCriteria ($criteriaKey, $configEntry, string $criteriaType = 'default') { // Add the configuration entry as a criteria $value = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($configEntry); $this->addCriteria($criteriaKey, $value, $criteriaType); @@ -265,7 +277,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @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 ($criteriaKey, $criteriaType = 'default') { + public function getCriteriaElemnent ($criteriaKey, string $criteriaType = 'default') { // Debug message //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(strtoupper($criteriaType) . '-CRITERIA: criteriaKey=' . $criteriaKey . ',criteriaType=' . $criteriaType . ' - CALLED!'); @@ -300,7 +312,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaKey The requested criteria key * @return $value Whether the value of the critera or false */ - public function getCriteriaChoiceElemnent ($criteriaKey) { + public function getCriteriaChoiceElemnent (string $criteriaKey) { // Call inner method return $this->getCriteriaElemnent($criteriaKey, 'choice'); } @@ -311,7 +323,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $criteriaKey The requested criteria key * @return $value Whether the value of the critera or false */ - public function getCriteriaExcludeElemnent ($criteriaKey) { + public function getCriteriaExcludeElemnent (string $criteriaKey) { // Call inner method return $this->getCriteriaElemnent($criteriaKey, 'exclude'); } @@ -323,7 +335,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @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, $criteriaType = 'default') { + public function ifEntryMatches (array $entryArray, string $criteriaType = 'default') { // First nothing matches and nothing is counted $matches = false; $counted = 0; @@ -388,7 +400,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @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(), $criteriaType = 'default') { + public function getCacheKey (array $onlyKeys = [], string $criteriaType = 'default') { // Debug message //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput($this->__toString() . ': criteriaType=' . $criteriaType . ',count()=' . $this->countGenericArray('criteria'))); @@ -444,7 +456,7 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $onlyKeys Only use these keys for a cache key * @return $cacheKey The key suitable for the cache system */ - public function getCacheKeyChoice ($onlyKeys = array()) { + public function getCacheKeyChoice (array $onlyKeys = []) { // Call inner method return $this->getCacheKey($onlyKeys, 'choice'); } @@ -455,23 +467,11 @@ abstract class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @param $onlyKeys Only use these keys for a cache key * @return $cacheKey The key suitable for the cache system */ - public function getCacheKeyExclude ($onlyKeys = array()) { + public function getCacheKeyExclude (array $onlyKeys = []) { // 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).