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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ldap-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ldap_connect</refname>
<refpurpose>Connect to an LDAP server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>LDAP\Connection</type><type>false</type></type><methodname>ldap_connect</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>uri</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<warning>
<simpara>
As of PHP 8.3.0, the <emphasis>following</emphasis> signature is deprecated.
</simpara>
</warning>
<methodsynopsis>
<type class="union"><type>LDAP\Connection</type><type>false</type></type><methodname>ldap_connect</methodname>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>host</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>389</initializer></methodparam>
</methodsynopsis>
<para>
Creates an <classname>LDAP\Connection</classname> connection and checks whether the given
<parameter>uri</parameter> is plausible.
</para>
<note>
<simpara>
This function does <emphasis>not</emphasis> open a connection.
It checks whether the given parameters are plausible and can be used
to open a connection as soon as one is needed.
</simpara>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<para>
A full LDAP URI of the form <literal>ldap://hostname:port</literal>
or <literal>ldaps://hostname:port</literal> for SSL encryption.
</para>
<para>
You can also provide multiple LDAP-URIs separated by a space as one string
</para>
<para>
Note that <literal>hostname:port</literal> is not a supported LDAP URI as the schema is missing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
The hostname to connect to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
The port to connect to.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <classname>LDAP\Connection</classname> instance when the provided LDAP URI
seems plausible. It's a syntactic check of the provided parameter but the server(s) will not
be contacted! If the syntactic check fails it returns &false;.
<function>ldap_connect</function> will otherwise
return a <classname>LDAP\Connection</classname> instance as it does not actually connect but just
initializes the connecting parameters. The actual connect happens with
the next calls to ldap_* functions, usually with
<function>ldap_bind</function>.
</para>
<para>
If no argument is specified then the <classname>LDAP\Connection</classname> instance of the already
opened connection will be returned.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.3.0</entry>
<entry>
Calling <function>ldap_connect</function> with separate
<parameter>hostname</parameter> and <parameter>port</parameter>
is now deprecated.
</entry>
</row>
<row>
<entry>8.1.0</entry>
<entry>
Returns an <classname>LDAP\Connection</classname> instance now;
previously, a &resource; was returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example of connecting to LDAP server.</title>
<programlisting role="php">
<![CDATA[
<?php
// LDAP variables
$ldapuri = "ldap://ldap.example.com:389"; // your ldap-uri
// Connecting to LDAP
$ldapconn = ldap_connect($ldapuri)
or die("That LDAP-URI was not parseable");
?>
]]>
</programlisting>
</example>
<example>
<title>Example of connecting securely to LDAP server.</title>
<programlisting role="php">
<![CDATA[
<?php
// make sure your host is the correct one
// that you issued your secure certificate to
$ldaphost = "ldaps://ldap.example.com/";
// Connecting to LDAP
$ldapconn = ldap_connect($ldaphost)
or die("That LDAP-URI was not parseable");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ldap_bind</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
-->
|
