summaryrefslogtreecommitdiff
path: root/documentation/install.html
blob: 753de5d92b73bd965464a6fa87fd2a2532028ead (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
<h1>How to install PHP-CPP</h1>
<p>
    Before you can build your own super fast native PHP extension using the 
    PHP-CPP library, you will first have to install the PHP-CPP library on your 
    system(s).
</p>
<p>
    Luckily, for most of us (those who use Linux or Apple environments), this 
    will be a piece of cake. If you're on a different platform however, you are 
    left on your own, because we (as in me, the PHP-CPP developer), only uses 
    Linux systems. There is however no reason why this library should not also 
    work on other platforms, because it only uses straight forward C++ code. 
    Thus, if you are on a different platform and have managed to compile the 
    library on it, please give us feedback so that we can update these 
    installation instructions and include other platforms as well.
</p>

<h2 id="download">Download</h2>
<p>
    Installation begins with downloading the source code. You can either
    download the latest release from our
    <a href="http://www.php-cpp.com/download">download</a> page, or get the
    latest bleeding edge work-in-progress version from 
    <a href="https://github.com/CopernicaMarketingSoftware/PHP-CPP">GitHub</a>.
</p>
<p>
    To get the latest GitHub version, run the following command from the command
    line:
</p>
<p>
    <pre><code>git clone https://github.com/CopernicaMarketingSoftware/PHP-CPP.git</code></pre>
</p>
<p>
    After you've downloaded the software (either from our website, or directly
    from GitHub), change your working directory to the PHP-CPP directory, and open
    the file named "Makefile" with your editor of choice.
</p>
<p>
    The Makefile is a file that holds settings and instructions for the compiler.
    In 96 out of 100 situations, the default settings in this Makefile will
    already be perfect for you, but you may want to have a look at it and make
    (small) changes to it. You can for example change the installation directory,
    and the compiler that is going to be used.
</p>
<p>
    After you've checked that all settings in the Makefile are correct, you can
    build the software. Do this by running the following command from within
    the PHP-CPP directory.
</p>
<p>
    <pre><code>make</code></pre>
</p>
<p>
    This will start the compiler and build the library.
</p>
<p>
    After you ran 'make', and the PHP-CPP library was built, all that is left to do is 
    install it on your system. You can use the "make install" command for it.
    This command should be executed as root, either by using "sudo", or by
    logging on as root first.
</p>
<p>
    <pre><code>sudo make install</code></pre>
</p>
<p>
    We've heard reports from some users that when they try to run their first extension,
    an error is reported that the "libphpcpp.so" can not be located on their system.
    To fix this, you should update the shared library cache on your system. This 
    can be done with the "ldconfig" command.
</p>
<p>
    <pre><code>sudo make install</code></pre>
</p>
<p>
    That was it! After these steps you are now the happy owner of a system with 
    PHP-CPP installed and nothing can stop you from building your first fast 
    native PHP extension.
</p>

<h2 id="osx">Compiling on OSX?</h2>
<p>
    If you try to compile the software on OSX, you may run into linking and "unresolved
    symbol" errors. In that case you should make a change to the Makefile.
    Somewhere in the Makefile there is an option "LINKER_FLAGS". This option
    should be modified, the flag "-undefined dynamic_lookup" should
    be added to it.
</p>