Introduced unsetCriteria()

[core.git] / inc / classes / interfaces / criteria / class_Criteria.php

diff --git a/inc/classes/interfaces/criteria/class_Criteria.php b/inc/classes/interfaces/criteria/class_Criteria.php
index 0a1264ccc9f8d33f2c39a52f3b95eeb6394980fd..6f515ec9ea5c27ff4c668c23a63360b45e57804c 100644 (file)
--- a/inc/classes/interfaces/criteria/class_Criteria.php
+++ b/inc/classes/interfaces/criteria/class_Criteria.php
@@ -84,6 +84,14 @@ interface Criteria extends FrameworkInterface {
         */
        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.
@@ -126,27 +134,27 @@ interface Criteria extends FrameworkInterface {
        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 null if not found for 'choice' type
+        * 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 null
+        * @return      $value                  Whether the value of the critera or FALSE
         */
        function getCriteriaChoiceElemnent ($criteriaKey);
 
        /**
-        * Get criteria element or null if not found for 'exclude' type
+        * 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 null
+        * @return      $value                  Whether the value of the critera or FALSE
         */
        function getCriteriaExcludeElemnent ($criteriaKey);