Used convertDashesToUnderscores()
[core.git] / inc / classes / main / criteria / class_BaseCriteria.php
1 <?php
2 /**
3  * A general crtieria class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24 class BaseCriteria extends BaseFrameworkSystem {
25         /**
26          * Wrapper class name stored in config entry
27          */
28         private $wrapperConfigEntry = '';
29
30         /**
31          * Criteria to handle
32          */
33         private $criteria = array();
34         /**
35          * Protected constructor
36          *
37          * @param       $className      Name of the class
38          * @return      void
39          */
40         protected function __construct ($className) {
41                 // Call parent constructor
42                 parent::__construct($className);
43         }
44
45         /**
46          * Setter for wrapper class name
47          *
48          * @param       $wrapperConfigEntry             Configuration entry which hold the wrapper class' name
49          * @return      void
50          */
51         public final function setWrapperConfigEntry ($wrapperConfigEntry) {
52                 $this->wrapperConfigEntry = (string) $wrapperConfigEntry;
53         }
54
55         /**
56          * Getter for wrapper class name
57          *
58          * @return      $wrapperConfigEntry             Configuration entry which hold the wrapper class' name
59          */
60         public final function getWrapperConfigEntry () {
61                 return $this->wrapperConfigEntry;
62         }
63
64         /**
65          * Getter for criteria array
66          *
67          * @return      $criteria
68          */
69         public final function getCriteriaArray () {
70                 return $this->criteria;
71         }
72
73         /**
74          * Add criteria, this method converts dashes to underscores because dashes
75          * are not valid for criteria keys.
76          *
77          * @param       $criteriaKey    Criteria key
78          * @param       $criteriaValue  Criteria value
79          * @return      void
80          */
81         public final function addCriteria ($criteriaKey, $criteriaValue) {
82                 $this->criteria[$this->convertDashesToUnderscores($criteriaKey)] = (string)$criteriaValue;
83         }
84
85         /**
86          * Add configured criteria
87          *
88          * @param       $criteriaKey    Criteria key
89          * @param       $configEntry    Configuration entry
90          * @return      void
91          */
92         public final function addConfiguredCriteria ($criteriaKey, $configEntry) {
93                 // Add the configuration entry as a criteria
94                 $value = $this->getConfigInstance()->getConfigEntry($configEntry);
95                 $this->addCriteria($criteriaKey, $value);
96         }
97
98         /**
99          * Get criteria element or null if not found
100          *
101          * @param       $criteriaKey    The requested criteria key
102          * @return      $value                  Whether the value of the critera or null
103          */
104         public function getCriteriaElemnent ($criteriaKey) {
105                 // Convert dashes to underscore
106                 $criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
107
108                 // Default is not found
109                 $value = NULL;
110
111                 // Is the criteria there?
112                 if (isset($this->criteria[$criteriaKey])) {
113                         // Then use it
114                         $value = $this->criteria[$criteriaKey];
115                 }
116
117                 // Return the value
118                 return $value;
119         }
120
121         /**
122          * Checks whether given array entry matches
123          *
124          * @param       $entryArray             Array with the entries to find
125          * @return      $matches                Whether the entry matches or not
126          */
127         public function ifEntryMatches (array $entryArray) {
128                 // First nothing matches and nothing is counted
129                 $matches = false;
130                 $counted = 0;
131
132                 // Walk through all entries
133                 foreach ($entryArray as $key => $entry) {
134                         // Convert dashes to underscore
135                         $key = $this->convertDashesToUnderscores($key);
136
137                         // Then walk through all search criteria
138                         foreach ($this->criteria as $criteriaKey => $criteriaValue) {
139                                 // Convert dashes to underscore
140                                 $criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
141
142                                 // Is the element found and does it match?
143                                 if (($key == $criteriaKey) && ($criteriaValue == $entry)) {
144                                         // Then count this one up
145                                         $counted++;
146                                 } // END - if
147                         } // END - foreach
148                 } // END - foreach
149
150                 // Now check if expected criteria counts match
151                 $matches = ($counted == count($this->criteria));
152
153                 // Return the result
154                 return $matches;
155         }
156
157         /**
158          * "Getter" for a cache key
159          *
160          * @param       $onlyKeys       Only use these keys for a cache key
161          * @return      $cacheKey       The key suitable for the cache system
162          */
163         public function getCacheKey ($onlyKeys = array()) {
164                 // Initialize the key
165                 $cacheKey = '';
166
167                 // Now walk through all criterias
168                 foreach ($this->criteria as $criteriaKey => $criteriaValue) {
169                         // Convert dashes to underscore
170                         $criteriaKey = $this->convertDashesToUnderscores($criteriaKey);
171
172                         // Is the value in array or is $onlyKeys empty?
173                         if ((isset($onlyKeys[$criteriaKey])) || (count($onlyKeys) == 0)) {
174                                 // Add the value URL encoded to avoid any trouble with special characters
175                                 $cacheKey .= sprintf("%s=%s;",
176                                         $criteriaKey,
177                                         urlencode($criteriaValue)
178                                 );
179                         } // END - if
180                 } // END - foreach
181
182                 // Remove last semicolon
183                 $cacheKey = substr($cacheKey, 0, -1);
184
185                 // Is the instance SearchCriteria?
186                 if ($this instanceof SearchCriteria) {
187                         // Check if 'limit' and 'skip' are in
188                         if (((isset($onlyKeys['limit'])) && (isset($onlyKeys['skip']))) || (count($onlyKeys) == 0)) {
189                                 // Add limit and skip values
190                                 $cacheKey .= sprintf(";%%limit%%=%s;%%skip%%=%s",
191                                         $this->getLimit(),
192                                         $this->getSkip()
193                                 );
194                         } // END - if
195                 } // END - if
196
197                 // Return the cache key
198                 return $cacheKey;
199         }
200 }
201
202 // [EOF]
203 ?>