Updated domain without a dash :(

[core.git] / inc / classes / main / criteria / class_BaseCriteria.php

diff --git a/inc/classes/main/criteria/class_BaseCriteria.php b/inc/classes/main/criteria/class_BaseCriteria.php
index d02c32fca8d75024538929a1fde57d7fec5c93d1..929b048f9c84815ab6edcc17e4fad281bbc30fa5 100644 (file)
--- 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 <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
  * @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');
        }
 
        /**
@@ -137,6 +131,26 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria {
                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, 'entries', $criteriaKey);
+               } // END - foreach
+       }
+
        /**
         * Add criteria, this method converts dashes to underscores because dashes
         * are not valid for criteria keys.
@@ -156,14 +170,8 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria {
                // Debug message
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __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);
        }
 
        /**
@@ -182,7 +190,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria {
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($criteriaType) . '(' . $this->__toString() . ')-CRITERIA[' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteriaValue=' . $criteriaValue);
 
                // Add it
-               $this->criteria['choice'][$this->convertDashesToUnderscores($criteriaKey)][] = (string) $criteriaValue;
+               $this->pushValueToGenericArrayElement('criteria', 'choice', 'entries', $this->convertDashesToUnderscores($criteriaKey), (string) $criteriaValue);
        }
 
        /**
@@ -227,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[' . __LINE__ . ']: criteriaKey=' . $criteriaKey . ',criteria()=' . $this->countGenericArrayGroup('criteria', $criteriaType)));
 
                // Default is not found
                $value = FALSE;
@@ -235,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
@@ -273,7 +281,7 @@ class BaseCriteria extends BaseFrameworkSystem implements Criteria {
         */
        public function ifEntryMatches (array $entryArray, $criteriaType = 'default') {
                // First nothing matches and nothing is counted
-               $matches = false;
+               $matches = FALSE;
                $counted = 0;
 
                // Walk through all entries
@@ -285,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)));
 
@@ -301,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;
@@ -338,18 +346,19 @@ 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)));
+                       assert(!is_array($criteriaValue));
 
                        // Convert dashes to underscore
                        $criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
@@ -414,7 +423,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);
        }
 
        /**