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
171
172
173
174
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dl" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dl</refname>
<refpurpose>Loads a PHP extension at runtime</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dl</methodname>
<methodparam><type>string</type><parameter>extension_filename</parameter></methodparam>
</methodsynopsis>
<para>
Loads the PHP extension given by the parameter
<parameter>extension_filename</parameter>.
</para>
<para>
Use <function>extension_loaded</function> to test whether a given
extension is already available or not. This works on both built-in
extensions and dynamically loaded ones (either through &php.ini; or
<function>dl</function>).
</para>
<warning>
<simpara>
This function is only available for the <acronym>CLI</acronym> and embed <acronym>SAPI</acronym>s,
and the <acronym>CGI</acronym> <acronym>SAPI</acronym> when run from the command line.
</simpara>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>extension_filename</parameter></term>
<listitem>
<para>
This parameter is <emphasis>only</emphasis> the filename of the
extension to load which also depends on your platform. For example,
the <link linkend="ref.sockets">sockets</link> extension (if compiled
as a shared module, not the default!) would be called
<filename>sockets.so</filename> on Unix platforms whereas it is called
<filename>php_sockets.dll</filename> on the Windows platform.
</para>
<para>
The directory where the extension is loaded from depends on your
platform:
</para>
<para>
Windows - If not explicitly set in the &php.ini;, the extension is
loaded from <filename>C:\php5\</filename> by default.
</para>
<para>
Unix - If not explicitly set in the &php.ini;, the default extension
directory depends on
<itemizedlist>
<listitem>
<simpara>
whether PHP has been built with <literal>--enable-debug</literal>
or not
</simpara>
</listitem>
<listitem>
<simpara>
whether PHP has been built with ZTS (Zend Thread Safety)
support or not
</simpara>
</listitem>
<listitem>
<simpara>
the current internal <literal>ZEND_MODULE_API_NO</literal> (Zend
internal module API number, which is basically the date on which a
major module API change happened, e.g. <literal>20010901</literal>)
</simpara>
</listitem>
</itemizedlist>
Taking into account the above, the directory then defaults to
<literal><install-dir>/lib/php/extensions/ <debug-or-not>-<zts-or-not>-ZEND_MODULE_API_NO</literal>,
e.g.
<filename>/usr/local/php/lib/php/extensions/debug-non-zts-20010901</filename>
or
<filename>/usr/local/php/lib/php/extensions/no-debug-zts-20010901</filename>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; If the functionality of loading modules is not available
or has been disabled (by setting
<link linkend="ini.enable-dl">enable_dl</link> off
in &php.ini;) an <constant>E_ERROR</constant> is emitted
and execution is stopped. If <function>dl</function> fails because the
specified library couldn't be loaded, in addition to &false; an
<constant>E_WARNING</constant> message is emitted.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>dl</function> examples</title>
<programlisting role="php">
<![CDATA[
<?php
// Example loading an extension based on OS
if (!extension_loaded('sqlite')) {
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
dl('php_sqlite.dll');
} else {
dl('sqlite.so');
}
}
// Or using PHP_SHLIB_SUFFIX constant
if (!extension_loaded('sqlite')) {
$prefix = (PHP_SHLIB_SUFFIX === 'dll') ? 'php_' : '';
dl($prefix . 'sqlite.' . PHP_SHLIB_SUFFIX);
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<function>dl</function> is case sensitive on Unix platforms.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="ini.extension">Extension Loading Directives</link></member>
<member><function>extension_loaded</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
