<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ldap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.ldap-connect.php',
    1 => 'ldap_connect',
    2 => 'LDAP サーバーへ接続する',
  ),
  'up' => 
  array (
    0 => 'ref.ldap.php',
    1 => 'LDAP 関数',
  ),
  'prev' => 
  array (
    0 => 'function.ldap-compare.php',
    1 => 'ldap_compare',
  ),
  'next' => 
  array (
    0 => 'function.ldap-connect-wallet.php',
    1 => 'ldap_connect_wallet',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ldap/functions/ldap-connect.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ldap-connect" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ldap_connect</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">ldap_connect</span> &mdash; <span class="dc-title">LDAP サーバーへ接続する</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.ldap-connect-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ldap_connect</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$uri</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="class.ldap-connection.php" class="type LDAP\Connection">LDAP\Connection</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <div class="warning"><strong class="warning">警告</strong>
   <p class="simpara">
    PHP 8.3.0 以降では、<em>次の</em> シグネチャは推奨されなくなりました。
   </p>
  </div>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ldap_connect</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$host</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$port</code><span class="initializer"> = 389</span></span>): <span class="type"><span class="type"><a href="class.ldap-connection.php" class="type LDAP\Connection">LDAP\Connection</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>
   クラスのインスタンスを作成し、指定した
   <code class="parameter">uri</code>
   が妥当であるかどうかを調べます。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <span class="simpara">
     注意: この関数は、接続を確立するするわけでは <em>ありません</em>。
     指定したパラメータが妥当であり、必要に応じて接続をオープンできるかどうかを調べるだけです。
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ldap-connect-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">uri</code></dt>
     <dd>
      <p class="para">
       完全な LDAP URI を指定します。<code class="literal">ldap://hostname:port</code>
       形式、あるいは SSL を用いる場合は <code class="literal">ldaps://hostname:port</code> 形式が使えます。
      </p>
      <p class="para">
       複数の LDAP URI を指定する場合は、間にスペースをはさんだひとつの文字列とします。
      </p>
      <p class="para">
       <code class="literal">hostname:port</code> 形式は LDAP URI としてサポートされないことに注意しましょう。
       スキーマが抜けているからです。
      </p>
     </dd>
    
    
     <dt><code class="parameter">host</code></dt>
     <dd>
      <p class="para">
       接続するホスト名
      </p>
     </dd>
    
    
     <dt><code class="parameter">port</code></dt>
     <dd>
      <p class="para">
       接続するポート。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ldap-connect-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   LDAP URI が妥当であると思われる場合には
   <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span> クラスのインスタンスを返します。
   これは単なる構文チェックであり、実際にサーバーに接続するわけではありません。
   構文チェックに失敗した場合は <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
   失敗していない場合は、<span class="function"><strong>ldap_connect()</strong></span>
   は常に <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>
   クラスのインスタンスを返しますが、
   実際には接続せずにパラメータの初期化だけを行います。
   実際に接続するのは次に ldap_* 関数がコールされた際で、これは
   通常は <span class="function"><a href="function.ldap-bind.php" class="function">ldap_bind()</a></span> です。
  </p>
  <p class="para">
   引数が指定されない場合、既に開かれている接続を示す
   <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>
   クラスのインスタンスを返します。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.ldap-connect-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.3.0</td>
      <td>
       <span class="function"><strong>ldap_connect()</strong></span> に、
       <code class="parameter">hostname</code> と <code class="parameter">port</code>
       を別々に渡してコールすることは、推奨されなくなりました。
      </td>
     </tr>

     <tr>
      <td>8.1.0</td>
      <td>
       <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>
       クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、
       <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> を返していました。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.ldap-connect-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 LDAP サーバーに接続する例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// LDAP 変数<br /></span><span style="color: #0000BB">$ldapuri </span><span style="color: #007700">= </span><span style="color: #DD0000">"ldap://ldap.example.com:389"</span><span style="color: #007700">;  </span><span style="color: #FF8000">// ldap-uri<br /><br />// LDAP に接続します<br /></span><span style="color: #0000BB">$ldapconn </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$ldapuri</span><span style="color: #007700">)<br />          or die(</span><span style="color: #DD0000">"That LDAP-URI was not parseable"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
   <div class="example" id="example-2">
    <p><strong>例2 LDAP サーバーへのセキュアな接続の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// サーバー証明書が証明するホストであることを<br />// 確認する<br /></span><span style="color: #0000BB">$ldaphost </span><span style="color: #007700">= </span><span style="color: #DD0000">"ldaps://ldap.example.com/"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// LDAP に接続します<br /></span><span style="color: #0000BB">$ldapconn </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$ldaphost</span><span style="color: #007700">)<br />          or die(</span><span style="color: #DD0000">"That LDAP-URI was not parseable"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ldap-connect-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.ldap-bind.php" class="function" rel="rdfs-seeAlso">ldap_bind()</a> - LDAP ディレクトリにバインドする</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>