ldap-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 57c38af2b053068ad0f1dfdead8128b957ccf4f0 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ldap-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_connect</refname>
  <refpurpose>Подключается к серверу LDAP</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>
    Начиная с PHP 8.3.0 <emphasis>следующая</emphasis> сигнатура устарела:
   </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>
   Создаёт объект <classname>LDAP\Connection</classname> и проверяет правдоподобность
   заданного в параметре <parameter>uri</parameter> значения.
  </para>
  <note>
   <simpara>
    Эта функция <emphasis>не</emphasis> открывает соединение.
    Она проверяет, правдоподобны ли заданные параметры и можно
    ли, указав их, установить соединение, когда оно необходимо.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>host</parameter></term>
     <listitem>
      <para>
       Полный LDAP URI вида <literal>ldap://hostname:port</literal>
       или <literal>ldaps://hostname:port</literal>.
      </para>
      <para>Можно также указать несколько LDAP-URI, разделённых пробелом.
      </para>
      <para>
       Обратите внимание, что <literal>hostname:port</literal> — это неподдерживаемый
       LDAP URI, так как отсутствует схема.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>uri</parameter></term>
     <listitem>
      <para>
       Имя сервера для соединения.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       Порт для соединения.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает экземпляр <classname>LDAP\Connection</classname>, если LDAP URI правдоподобен.
   Она производит синтаксический разбор и
   проверку переданных параметров, но соединения с сервером не происходит. Если проверка
   синтаксиса провалилась — возвращается &false;.
   Функция <function>ldap_connect</function> всегда будет возвращать экземпляр <classname>LDAP\Connection</classname>,
   поскольку она фактически не соединяется, а только инициализирует параметры соединения.
   Фактическое подключение происходит при последующих вызовах функций ldap_*, обычно
   при вызове функции <function>ldap_bind</function>.
  </para>
  <para>
   Если никакие параметры не будут определены, тогда будет возвращён экземпляр
   открытого соединения — <classname>LDAP\Connection</classname>.
  </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>
       Теперь вызов функции <function>ldap_connect</function> с отдельным указанием
       имени хоста <parameter>hostname</parameter> и порта <parameter>port</parameter>
       устарел.
      </entry>
     </row>
     <row>
      <entry>8.1.0</entry>
      <entry>
       Возвращает экземпляр <classname>LDAP\Connection</classname>;
       ранее возвращался ресурс (&resource;).
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример подключения к серверу LDAP.</title>
    <programlisting role="php">
<![CDATA[
<?php

// LDAP переменные
$ldapuri = "ldap://ldap.example.com:389";  // ldap-uri

// Соединение с LDAP
$ldapconn = ldap_connect($ldapuri)
          or die("LDAP-URI некорректен");

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Пример безопасного подключения к серверу LDAP.</title>
    <programlisting role="php">
<![CDATA[
<?php

// Убедитесь, что ваш хост корректный и
// что вы выдали ему сертификат безопасности
$ldaphost = "ldaps://ldap.example.com/";

// Соединение с LDAP
$ldapconn = ldap_connect($ldaphost)
          or die("LDAP-URI некорректен");

?>
]]>
    </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
-->