X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=inc%2Fclasses%2Fmain%2Fcriteria%2Fclass_BaseCriteria.php;h=86e67857b732e7d4fe148a13b4a2d4556a26cf48;hb=6f3b09f6a22137eb528d1a76424293f1f7103780;hp=cbf192d36e31d567475985f926681e1978eacda4;hpb=f5cf5211620c1813c76d8231819b63a585fb2689;p=core.git diff --git a/inc/classes/main/criteria/class_BaseCriteria.php b/inc/classes/main/criteria/class_BaseCriteria.php index cbf192d3..86e67857 100644 --- a/inc/classes/main/criteria/class_BaseCriteria.php +++ b/inc/classes/main/criteria/class_BaseCriteria.php @@ -2,11 +2,11 @@ /** * A general crtieria class * - * @author Roland Haeder + * @author Roland Haeder * @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 @@ -27,18 +27,6 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { */ private $wrapperConfigEntry = ''; - /** - * Criteria to handle - */ - private $criteria = array( - // Default - 'default' => array(), - // Choice - 'choice' => array(), - // .. and exclude - 'exclude' => array(), - ); - /** * Protected constructor * @@ -48,6 +36,12 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { 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 } /** @@ -62,7 +56,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { assert((strpos($criteriaKey, 'my-') === FALSE) && (strpos($criteriaKey, 'my_') === FALSE)); // Determine it - $isSet = isset($this->criteria[$criteriaType][$criteriaKey]); + $isSet = $this->isGenericArrayElementSet('criteria', $criteriaType, 'entries', $criteriaKey); // Return it return $isSet; @@ -116,7 +110,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { * @return $criteria */ public final function getCriteriaArray ($criteriaType = 'default') { - return $this->criteria[$criteriaType]; + return $this->getGenericArrayKey('criteria', $criteriaType, 'entries'); } /** @@ -151,9 +145,9 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { $criteriaKey = $this->convertDashesToUnderscores($criteriaKey); // "Walk" through all criterias - foreach ($this->criteria as $criteriaType => $dummy) { + foreach ($this->getGenericArray('criteria') as $criteriaType => $dummy) { // Remove it - unset($this->criteria[$criteriaType][$criteriaKey]); + $this->unsetGenericArrayElement('criteria', $criteriaType, 'entries', $criteriaKey); } // END - foreach } @@ -174,16 +168,10 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { $criteriaKey = $this->convertDashesToUnderscores($criteriaKey); // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue); - // Is it already there? - if ($this->isKeySet($criteriaType, $criteriaKey)) { - // Append it - $this->criteria[$criteriaType][$criteriaKey] .= ',' . (string) $criteriaValue; - } else { - // Add it - $this->criteria[$criteriaType][$criteriaKey] = (string) $criteriaValue; - } + // Append it + $this->appendStringToGenericArrayElement('criteria', $criteriaType, 'entries', $criteriaKey, $criteriaValue); } /** @@ -199,10 +187,10 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { 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); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __METHOD__ . ':' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue); // Add it - array_push($this->criteria['choice'][$this->convertDashesToUnderscores($criteriaKey)], (string) $criteriaValue); + $this->pushValueToGenericArrayElement('criteria', 'choice', 'entries', $this->convertDashesToUnderscores($criteriaKey), (string) $criteriaValue); } /** @@ -247,7 +235,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { $criteriaKey = $this->convertDashesToUnderscores($criteriaKey); // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '-CRITERIA[' . __LINE__ . ']: 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 = FALSE; @@ -255,7 +243,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { // Is the criteria there? 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 @@ -305,7 +293,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { $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))); @@ -321,7 +309,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { } // 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; @@ -358,26 +346,29 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { */ 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) ); @@ -392,7 +383,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { // 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() ); @@ -434,7 +425,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria { */ public final function count ($criteriaType = 'default') { // Return it - return count($this->criteria[$criteriaType]); + return $this->countGenericArrayGroup('criteria', $criteriaType); } /**