src/IniSection.hpp

   1 /*
   2     suPHP - (c)2002-2008 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_INISECTION_H
  22
  23 namespace suPHP {
  24     class IniSection;
  25 };
  26
  27 #define SUPHP_INISECTION_H
  28
  29 #include <string>
  30 #include <vector>
  31 #include <map>
  32
  33 #include "KeyNotFoundException.hpp"
  34 #include "File.hpp"
  35 #include "IniFile.hpp"
  36
  37 namespace suPHP {
  38     /**
  39      * Class providing access to configuration in a INI file.
  40      */
  41     class IniSection {
  42     private:
  43         std::multimap<const std::string, const std::string> entries;
  44         void putValue(const std::string key, const std::string value);
  45         void removeValues(const std::string& key);
  46
  47     public:
  48         /**
  49          * Returns values corresponding to key
  50          */
  51         const std::vector<std::string> getValues(const std::string& key) const
  52             throw (KeyNotFoundException);
  53
  54         /**
  55          * Returns first value corresponding to a key
  56          */
  57         std::string getValue(const std::string& key) const throw (KeyNotFoundException);
  58
  59         /**
  60          * Returns keys appearing in this section
  61          */
  62         const std::vector<std::string> getKeys() const;
  63         /**
  64          * Overloaded index operator, calls getValues()
  65          */
  66         const std::vector<std::string> operator[](const std::string& key) const
  67             throw (KeyNotFoundException);
  68
  69         friend class IniFile;
  70
  71         /**
  72          * Check wheter key is existing within section
  73          */
  74         bool hasKey(const std::string& name) const;
  75     };
  76 };
  77
  78 #endif // SUPHP_INISECTION_H