summaryrefslogtreecommitdiff
path: root/include/hashparent.h
blob: 4c2ee68655d768bab12bf9ce1dc08d4bde19ec04 (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
/**
 *  HashParent.h
 *
 *  Interface that is implemented by all objects that can be accessed with
 *  array-access variables ([]). When the value of a hash-member is changed,
 *  it will call one of the methods from this class to set the new property
 *
 *  This is an internal class that you normally not need when writing 
 *  extensions. It is used by the PHP-CPP library when you use constructs
 *  like value["x"]["y"] = 10;
 *
 *  @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
 *  @copyright 2014 Copernica BV
 */

/**
 *  Set up namespace
 */
namespace Php {
    
/**
 *  Forwards
 */
class Value;

/**
 *  Class definition
 */
class HashParent
{
protected:
    /**
     *  Protected constructor - users should not instantiate HashParent
     *  objects themselved. Use a Value object instead.
     */
    HashParent() {}
    
public:
    /**
     *  Destructor
     */
    virtual ~HashParent() {}
    
    /**
     *  Check if a certain key exists in the array/object
     *  @param  key
     *  @return bool
     */
    virtual bool contains(const std::string &key) const = 0;
    
    /**
     *  Check if a certain index exists in the array/object
     *  @param  key
     *  @return bool
     */
    virtual bool contains(int index) const = 0;
    
    /**
     *  Retrieve the value at a string index
     *  @param  key
     *  @return Value
     */
    virtual Value get(const std::string &key) const = 0;
    
    /**
     *  Retrieve the value at a numeric index
     *  @param  index
     *  @return Value
     */
    virtual Value get(int index) const = 0;
    
    /**
     *  Overwrite the value at a certain string index
     *  @param  key
     *  @param  value
     */
    virtual void set(const std::string &key, const Value &value) = 0;
    
    /**
     *  Overwrite the value at a certain numeric index
     *  @param  index
     *  @param  value
     */
    virtual void set(int index, const Value &value) = 0;
    
};

/**
 *  End namespace
 */
}