mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
bd54ab1ff8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@165352 c90b9560-bf6c-de11-be94-00142212c4b1
105 lines
3.2 KiB
XML
105 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.ldap-connect">
|
|
<refnamediv>
|
|
<refname>ldap_connect</refname>
|
|
<refpurpose>Connect to an LDAP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>ldap_connect</methodname>
|
|
<methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns a positive LDAP link identifier on success, or &false; on
|
|
error. When OpenLDAP 2.x.x is used, <function>ldap_connect</function>
|
|
will always return a <type>resource</type> as it does not actually
|
|
connect but just initializes the connecting parameters. The actual
|
|
connect happens with the next calls to ldap_* funcs, usually with
|
|
<function>ldap_bind</function>.
|
|
</para>
|
|
<para>
|
|
<function>ldap_connect</function> establishes a connection to a
|
|
LDAP server on a specified <parameter>hostname</parameter> and
|
|
<parameter>port</parameter>. Both the arguments are optional. If
|
|
no arguments are specified then the link identifier of the
|
|
already opened link will be returned. If only
|
|
<parameter>hostname</parameter> is specified, then the port
|
|
defaults to 389.</para>
|
|
<para>
|
|
If you are using OpenLDAP 2.x.x you can specify a URL instead of the
|
|
hostname. To use LDAP with SSL, compile OpenLDAP 2.x.x with SSL
|
|
support, configure PHP with SSL, and use ldaps://hostname/ as
|
|
host parameter. The port parameter is not used when using URLs.
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
URL and SSL support were added in 4.0.4.
|
|
</simpara>
|
|
</note>
|
|
<example>
|
|
<title>Example of connecting to LDAP server.</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// LDAP variables
|
|
$ldaphost = "ldap.example.com"; // your ldap servers
|
|
$ldapport = 389; // your ldap server's port number
|
|
|
|
// Connecting to LDAP
|
|
$ldapconn = ldap_connect($ldaphost, $ldapport)
|
|
or die("Could not connect to $ldaphost");
|
|
|
|
?>
|
|
]]>
|
|
</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("Could not connect to {$ldaphost}");
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<para>
|
|
See also
|
|
<function>ldap_bind</function>.
|
|
</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:"../../../../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
|
|
-->
|