summaryrefslogtreecommitdiff
path: root/include/hashparent.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/hashparent.h')
-rw-r--r--include/hashparent.h31
1 files changed, 15 insertions, 16 deletions
diff --git a/include/hashparent.h b/include/hashparent.h
index 5ba05bd..b07a8f7 100644
--- a/include/hashparent.h
+++ b/include/hashparent.h
@@ -5,7 +5,7 @@
* 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
+ * 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;
*
@@ -17,7 +17,7 @@
* Set up namespace
*/
namespace Php {
-
+
/**
* Forwards
*/
@@ -26,7 +26,7 @@ class Value;
/**
* Class definition
*/
-class HashParent
+class PHPCPP_EXPORT HashParent
{
protected:
/**
@@ -34,41 +34,41 @@ protected:
* 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;
-
+
/**
* Check if a certain index exists in the array/object
* @param key
* @return bool
*/
virtual bool contains(const Value &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
@@ -82,34 +82,34 @@ public:
* @return Value
*/
virtual Value get(const Value &key) 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;
-
+
/**
* Overwrite the value at a certain variant index
* @param key
* @param value
*/
virtual void set(const Value &key, const Value &value) = 0;
-
+
/**
* Unset a member by its index
* @param index
*/
virtual void unset(int index) = 0;
-
+
/**
* Unset a member by its key
* @param key
@@ -121,11 +121,10 @@ public:
* @param key
*/
virtual void unset(const Value &key) = 0;
-
+
};
/**
* End namespace
*/
}
-