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
|
/**
* 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 PHPCPP_EXPORT Constant
{
public:
/**
* Constructor
* @param name Constant name
* @param value Constant value
* @param size Size of the value (in case of a string)
*/
Constant(const char *name, std::nullptr_t value = nullptr);
Constant(const char *name, bool value);
Constant(const char *name, int32_t value);
Constant(const char *name, int64_t value);
Constant(const char *name, double value);
Constant(const char *name, const char *value);
Constant(const char *name, const char *value, size_t size);
Constant(const char *name, const std::string &value);
/**
* Destructor
*/
virtual ~Constant() {}
/**
* Add the constant to a class
*
* You normally do not have to call this method yourself. You can simply
* do one of the following method calls to create class constants:
*
* myclass.property("MY_CONSTANT", "value", Php::Const);
* myclass.constant("MY_CONSTANT", "value");
* myclass.add(Php::Constant("MY_CONSTANT", "value"));
*
* All of the calls have the same result, it is up to you to decide which
* one suits you most. If you use the last one - using a Php::Constant
* class - the PHP-CPP library will call this "addTo()" method internally
* to forward the call to one of the other methods.
*
* @param clss Class to which the constant is added
* @internal
*/
void addTo(ClassBase &clss) const;
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
*/
}
|
