623e7ab4 |
1 | /* |
2 | suPHP - (c)2002-2005 Sebastian Marsching <sebastian@marsching.com> |
3 | |
4 | This file is part of suPHP. |
5 | |
6 | suPHP is free software; you can redistribute it and/or modify |
7 | it under the terms of the GNU General Public License as published by |
8 | the Free Software Foundation; either version 2 of the License, or |
9 | (at your option) any later version. |
10 | |
11 | suPHP is distributed in the hope that it will be useful, |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
14 | GNU General Public License for more details. |
15 | |
16 | You should have received a copy of the GNU General Public License |
17 | along with suPHP; if not, write to the Free Software |
18 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
19 | */ |
20 | |
21 | #ifndef SUPHP_ENVIRONMENT_H |
22 | |
23 | namespace suPHP { |
24 | class Environment; |
25 | }; |
26 | |
27 | #define SUPHP_ENVIRONMENT_H |
28 | |
29 | #include <string> |
30 | #include <map> |
31 | |
32 | #include "KeyNotFoundException.hpp" |
33 | |
34 | namespace suPHP { |
35 | /** |
36 | * Class containing environment variables. |
37 | */ |
38 | class Environment { |
39 | private: |
40 | std::map<std::string, std::string> vars; |
41 | |
42 | public: |
43 | /** |
44 | * Returns (copy of) variable content |
45 | */ |
46 | std::string getVar(const std::string& name) const |
47 | throw (KeyNotFoundException); |
48 | |
49 | /** |
50 | * Sets variable content |
51 | */ |
52 | void setVar(const std::string name, const std::string content) |
53 | throw (KeyNotFoundException); |
54 | |
55 | /** |
56 | * Adds variable to environment |
57 | */ |
58 | void putVar(const std::string name, const std::string content); |
59 | |
60 | /** |
61 | * Deletes variable from environment |
62 | */ |
63 | void deleteVar(const std::string& name) throw (KeyNotFoundException); |
64 | |
65 | /** |
66 | * Checks whether a variable is set |
67 | */ |
68 | bool hasVar(const std::string& name) const; |
69 | |
70 | /** |
71 | * Returns reference to variable with name |
72 | */ |
73 | std::string& operator[](const std::string& name) |
74 | throw (KeyNotFoundException); |
75 | |
76 | /** |
77 | * Returns const reference to the map which stores the variables |
78 | */ |
79 | const std::map<std::string, std::string>& getBackendMap() const; |
80 | }; |
81 | }; |
82 | |
83 | #endif // SUPHP_ENVIRONMENT_H |