summaryrefslogtreecommitdiff
path: root/documentation/compile-extensions.html
blob: 3e6396d6d50e451ffeed8768e57d9a8dd522471b (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
<div style="width: 1024px; font-family: verdana; font-size: 10pt; line-height: 16pt;">


<h1>Compile your own extensions</h1>
<p>
    When you build your own PHP-CPP extensions, you also have to compile and
    deploy them. A normal PHP script only has to be placed on a web server to be 
    deployed, but it takes a little more effort to deploy an extension.
</p>
<p>
    To help your users, customers, and/or operations department with deploying
    your native extensions, you best create a Makefile with settings and 
    instructions for the compiler. All that is then left for someone to install 
    your extension, is run "make" and "make install". And because it is PHP-CPP's 
    objective to make life easy, we give you already an example Makefile that 
    works on most Linux platforms.
</p>
<p>
    <code><pre>
        #
        #	Makefile template
        #
        #	This is an example Makefile that can be used by anyone who is building
        #	his or her own PHP extensions using the PHP-CPP library. 
        #
        #	In the top part of this file we have included variables that can be
        #	altered to fit your configuration, near the bottom the instructions and
        #	dependencies for the compiler are defined. The deeper you get into this
        #	file, the less likely it is that you will have to change anything in it.
        #

        #
        #	Name of your extension
        #
        #	This is the name of your extension. Based on this extension name, the
        #	name of the library file (name.so) and the name of the config file (name.ini)
        #	are automatically generated
        #

        NAME				=	yourextension


        #
        #	Php.ini directories
        #
        #	In the past, PHP used a single php.ini configuration file. Today, most
        #	PHP installations use a conf.d directory that holds a set of config files,
        #	one for each extension. Use this variable to specify this directory.
        #

        INI_DIR				=	/etc/php5/conf.d


        #
        #	The extension dirs
        #
        #	This is normally a directory like /usr/lib/php5/20121221 (based on the 
        #	PHP version that you use. We make use of the command line 'php-config' 
        #	instruction to find out what the extension directory is, you can override
        #	this with a different fixed directory
        #

        EXTENSION_DIR		=	$(shell php-config --extension-dir)


        #
        #	The name of the extension and the name of the .ini file
        #
        #	These two variables are based on the name of the extension. We simply add
        #	a certain extension to them (.so or .ini)
        #

        EXTENSION 			=	${NAME}.so
        INI 				=	${NAME}.ini


        #
        #	Compiler
        #
        #	By default, the GNU C++ compiler is used. If you want to use a different
        #	compiler, you can change that here. You can change this for both the 
        #	compiler (the program that turns the c++ files into object files) and for
        #	the linker (the program that links all object files into the single .so
        #	library file. By default, g++ (the GNU C++ compiler) is used for both.
        #

        COMPILER			=	g++
        LINKER				=	g++


        #
        #	Compiler and linker flags
        #
        #	This variable holds the flags that are passed to the compiler. By default, 
        # 	we include the -O2 flag. This flag tells the compiler to optimize the code, 
        #	but it makes debugging more difficult. So if you're debugging your application, 
        #	you probably want to remove this -O2 flag. At the same time, you can then 
        #	add the -g flag to instruct the compiler to include debug information in
        #	the library (but this will make the final libphpcpp.so file much bigger, so
        #	you want to leave that flag out on production servers).
        #
        #	If your extension depends on other libraries (and it does at least depend on
        #	one: the PHP-CPP library), you should update the LINKER_DEPENDENCIES variable
        #	with a list of all flags that should be passed to the linker.
        #

        COMPILER_FLAGS		=	-Wall -c -O2 -std=c++11 -fpic -o
        LINKER_FLAGS		=	-shared
        LINKER_DEPENDENCIES	=	-lphpcpp


        #
        #	Command to remove files, copy files and create directories.
        #
        #	I've never encountered a *nix environment in which these commands do not work. 
        #	So you can probably leave this as it is
        #

        RM					=	rm -f
        CP					=	cp -f
        MKDIR				=	mkdir -p


        #
        #	All source files are simply all *.cpp files found in the current directory
        #
        #	A builtin Makefile macro is used to scan the current directory and find 
        #	all source files. The object files are all compiled versions of the source
        #	file, with the .cpp extension being replaced by .o.
        #

        SOURCES				=	$(wildcard *.cpp)
        OBJECTS				=	$(SOURCES:%.cpp=%.o)


        #
        #	From here the build instructions start
        #

        all:					${OBJECTS} ${EXTENSION}

        ${EXTENSION}:			${OBJECTS}
                                ${LINKER} ${LINKER_FLAGS} -o $@ ${OBJECTS} ${LINKER_DEPENDENCIES}

        ${OBJECTS}:
                                ${COMPILER} ${COMPILER_FLAGS} $@ ${@:%.o=%.cpp}

        install:		
                                ${CP} ${EXTENSION} ${EXTENSION_DIR}
                                ${CP} ${INI} ${INI_DIR}
                        
        clean:
                                ${RM} ${EXTENSION} ${OBJECTS}

    </pre></code>
</p>
<p>
    But your extension should not only have a Makefile, but also an initial
    yourextension.ini file. This file is much simpler that the Makefile:
</p>
<p>
    <code><pre>
        extension=yourextension.so
    </pre></code>
</p>
<p>
    You can download both the Makefile and the ini file from our empty extension
    template, so that you can start making your application right away.
</p>