summaryrefslogtreecommitdiff
path: root/include/super.h
blob: d12d3764fa93ec7de5f9281d4f303713eac11c0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/**
 *  Super.h
 *
 *  The Super class is used to implement one of the super variables $_POST,
 *  $_GET, $_SERVER, et cetera
 *
 *  @copyright 2014 Copernica BV
 *  @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
 */

/**
 *  Set up namespace
 */
namespace Php {

/**
 *  Class definition
 */
class PHPCPP_EXPORT Super
{
public:
    /**
     *  Constructor
     *
     *  Extension writers do not have to access the super-globals themselves.
     *  They are always accessible via Php::POST, Php::GET, et cetera.
     *
     *  @param  index   index number
     *  @param  name    name of the variable in PHP
     */
    Super(int index, const char *name) : _index(index), _name(name) {}

    /**
     *  Destructor
     */
    virtual ~Super() {}

    /**
     *  Array access operator
     *  This can be used for accessing associative arrays
     *  @param  key
     *  @return Value
     */
    Value operator[](const std::string &key)
    {
        // convert object to a value object, and retrieve the key
        return value().get(key);
    }

    /**
     *  Array access operator
     *  This can be used for accessing associative arrays
     *  @param  key
     *  @return Value
     */
    Value operator[](const char *key)
    {
        // convert object to a value object, and retrieve the key
        return value().get(key);
    }

    /**
     *  Casting operator to cast to a value object
     *  @return Value
     */
    operator Value ()
    {
        // we have a private function for this
        return value();
    }

    /**
     *  Return an iterator for iterating over the variables
     *  @return iterator
     */
    ValueIterator begin()
    {
        // convert to value, and call begin on the value object
        return value().begin();
    }

    /**
     *  Return an iterator for iterating over the variables
     *  @return iterator
     */
    ValueIterator end()
    {
        // convert to value, and call end on that object
        return value().end();
    }

private:
    /**
     *  Index number
     *  @var    int
     */
    int _index;

    /**
     *  Name of the variable in PHP
     *  @var    name
     */
    const char *_name;

    /**
     *  Turn the object into a value object
     *  @return Value
     */
    Value value();

};

/**
 *  A number of super-globals are always accessible
 */
extern PHPCPP_EXPORT Super POST;
extern PHPCPP_EXPORT Super GET;
extern PHPCPP_EXPORT Super COOKIE;
extern PHPCPP_EXPORT Super SERVER;
extern PHPCPP_EXPORT Super ENV;
extern PHPCPP_EXPORT Super FILES;
extern PHPCPP_EXPORT Super REQUEST;

/**
 *  End namespace
 */
}