summaryrefslogtreecommitdiff
path: root/include/variable.h
blob: fccab9ced15ab410182c0989a1e84c75c84faead (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/**
 *  Variable.h
 *
 *  Base class for variables that are stored in the Zend engine.
 *
 *  @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
 *  @copyright 2013 Copernica BV
 */

/**
 *  Forward definitions
 */
struct _zval_struct;

/**
 *  Set up namespace
 */
namespace PhpCpp {

/**
 *  Class definition
 */
class Variable
{
public:
    /**
     *  Empty constructor (value = NULL)
     */
    Variable();
    
    /**
     *  Constructor based on integer value
     *  @param  value
     */
    Variable(int value);
    
    /**
     *  Constructor based on boolean value
     *  @param  value
     */
    Variable(bool value);
    
    /**
     *  Constructor based on string value
     *  @param  value
     */
    Variable(const std::string &value);
    
    /**
     *  Constructor based on decimal value
     *  @param  value
     */
    Variable(double value);
    
    /**
     *  Wrap object around zval
     *  @param  zval
     */
    Variable(struct _zval_struct *zval);
    
    /**
     *  Copy constructor
     *  @param  value
     */
    Variable(const Variable &that);
    
    /**
     *  Destructor
     */
    virtual ~Variable();

    /**
     *  Assignment operator
     *  @param  value
     *  @return Variable
     */
    virtual Variable &operator=(const Variable &value);
    
    /**
     *  Assignment operator
     *  @param  value
     *  @return Variable
     */
    Variable &operator=(int value);

    /**
     *  Assignment operator
     *  @param  value
     *  @return Variable
     */
    Variable &operator=(bool value);

    /**
     *  Assignment operator
     *  @param  value
     *  @return Variable
     */
    Variable &operator=(const std::string &value);
    
    /**
     *  Assignment operator
     *  @param  value
     *  @return Variable
     */
    Variable &operator=(double value);
    
    /**
     *  The type of object
     *  @return Type
     */
    Type type();
    
    /**
     *  Change the internal type of the variable
     *  @param  Type
     */
    void setType(Type type);

    /**
     *  Is this a NULL value?
     *  @return bool
     */
    bool isNull();

    /**
     *  Is this an integer value?
     *  @return bool
     */
    bool isInt();
    
    /**
     *  Is this a boolean value?
     *  @return bool
     */
    bool isBool();
    
    /**
     *  Is this a string value?
     *  @return bool
     */
    bool isString();
    
    /**
     *  Is this a decimal value?
     *  @return bool
     */
    bool isDecimal();
    
    /**
     *  Is this an object value?
     *  @return bool
     */
    bool isObject();
    
    /**
     *  Is this an array value?
     *  @return bool
     */
    bool isArray();
    
    /**
     *  Retrieve the value as integer
     *  @return int
     */
    int intValue();
    
    /**
     *  Retrieve the value as boolean
     *  @return bool
     */
    bool boolValue();
    
    /**
     *  Retrieve the value as string
     *  @return string
     */
    std::string stringValue();
    
    /**
     *  Retrieve the value as decimal
     *  @return double
     */
    double decimalValue();
    
    /**
     *  Cast to an int
     *  @return int
     */
    operator int ()
    {
        return intValue();
    }
    
    /**
     *  Cast to a boolean
     *  @return boolean
     */
    operator bool ()
    {
        return boolValue();
    }
    
    /**
     *  Cast to a string
     *  @return string
     */
    operator std::string ()
    {
        return stringValue();
    }
    
    /**
     *  Cast to a floating point
     *  @return double
     */
    operator double ()
    {
        return decimalValue();
    }

protected:
    /**
     *  The wrapped zval
     *  @var struct zval
     */
    struct _zval_struct *_val;

};

/**
 *  End of namespace
 */
}