added initial implementation for registering constants

1 files changed, 67 insertions, 0 deletions

diff --git a/include/constant.h b/include/constant.h
new file mode 100644
index 0000000..c6be099
--- /dev/null
+++ b/include/constant.h
@@ -0,0 +1,67 @@
+/**
+ *  Constant.h
+ * 
+ *  If you want to define global PHP constants, or class constants you can
+ *  use this constant class for it. Wrap the constant you'd like to create
+ *  in a Php::Constant object and add it to the extension or the class:
+ * 
+ *  extension.add(Php::Constant("CONSTANT_NAME", "value"));
+ *  myclass.add(Php::Constant("CLASS_CONSTANT", "value"));
+ * 
+ *  @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
+ *  @copyright 2015 Copernica BV
+ */
+
+/**
+ *  Set up namespace
+ */
+namespace Php {
+
+/**
+ *  Forward declarations
+ */
+class ConstantImpl;
+
+/**
+ *  Class definition
+ */
+class Constant
+{
+public:
+    /**
+     *  Constructor
+     *  @param  name            Constant name
+     *  @param  value           Constant value
+     */
+    Constant(const char *name, const Value &value);
+    
+    /**
+     *  Destructor
+     */
+    virtual ~Constant() {}
+
+private:
+    /**
+     *  Pointer to the actual implementation of the constant
+     *  @var    std::shared_ptr
+     */
+    std::shared_ptr<ConstantImpl> _impl;
+
+    /**
+     *  Get access to the implementation object
+     *  @return std::shared_ptr
+     */
+    const std::shared_ptr<ConstantImpl> &implementation() const { return _impl; }
+    
+    /**
+     *  The extension object has access to privates
+     */
+    friend class ExtensionImpl;
+
+};    
+    
+/**
+ *  End of namespace
+ */
+}
+