svn: /phpdoc/ja/trunk/reference/ldap/functions/ ldap-connect.xml ldap-list.xml ldap-read.xml ldap-search.xml
[email protected] (Yoshinari Takaoka) Thu, 10 Dec 2020 01:08:52 +0000
| Newsgroups | php.doc.ja |
|---|---|
| Message-ID | <[email protected]> |
mumumu Thu, 10 Dec 2020 01:08:52 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=351987
Log:
Update ext/ldap signatures to match PHP-8
Closes GH-242.
Changed paths:
U phpdoc/ja/trunk/reference/ldap/functions/ldap-connect.xml
U phpdoc/ja/trunk/reference/ldap/functions/ldap-list.xml
U phpdoc/ja/trunk/reference/ldap/functions/ldap-read.xml
U phpdoc/ja/trunk/reference/ldap/functions/ldap-search.xml
svn-diffs-351987.txt
(text/x-diff, 16.9 KB)
Modified: phpdoc/ja/trunk/reference/ldap/functions/ldap-connect.xml
===================================================================
--- phpdoc/ja/trunk/reference/ldap/functions/ldap-connect.xml 2020-12-10 00:57:15 UTC (rev 351986)
+++ phpdoc/ja/trunk/reference/ldap/functions/ldap-connect.xml 2020-12-10 01:08:52 UTC (rev 351987)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 347310 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351984 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.ldap-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
@@ -11,23 +11,23 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>resource</type><methodname>ldap_connect</methodname>
- <methodparam choice="opt"><type>string</type><parameter>ldap_uri</parameter><initializer>&null;</initializer></methodparam>
+ <type class="union"><type>resource</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>
- <emphasis>次の</emphasis> シグナチャは後方互換のためまだサポートされていますが、
+ <emphasis>次の</emphasis> シグナチャは(名前付き引数以外の)後方互換のためまだサポートされていますが、
非推奨と見なされているのでもう使わないでください！
</simpara>
</warning>
<methodsynopsis>
- <type>resource</type><methodname>ldap_connect</methodname>
+ <type class="union"><type>resource</type><type>false</type></type><methodname>ldap_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>host</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>389</initializer></methodparam>
</methodsynopsis>
<para>
LDAP リンク ID を作成して、指定した
- <parameter>host</parameter> および <parameter>port</parameter>
+ <parameter>uri</parameter>
が妥当であるかどうかを調べます。
</para>
<note>
@@ -43,7 +43,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>ldap_uri</parameter></term>
+ <term><parameter>uri</parameter></term>
<listitem>
<para>
完全な LDAP URI を指定します。<literal>ldap://hostname:port</literal>
@@ -145,7 +145,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/ldap/functions/ldap-list.xml
===================================================================
--- phpdoc/ja/trunk/reference/ldap/functions/ldap-list.xml 2020-12-10 00:57:15 UTC (rev 351986)
+++ phpdoc/ja/trunk/reference/ldap/functions/ldap-list.xml 2020-12-10 01:08:52 UTC (rev 351987)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 347307 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351984 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.ldap-list" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
@@ -11,16 +11,16 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>resource</type><methodname>ldap_list</methodname>
- <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
- <methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
- <methodparam><type>string</type><parameter>filter</parameter></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>array("*")</initializer></methodparam>
- <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter><initializer>0</initializer></methodparam>
+ <type class="union"><type>resource</type><type>array</type><type>false</type></type><methodname>ldap_list</methodname>
+ <methodparam><type class="union"><type>resource</type><type>array</type></type><parameter>ldap</parameter></methodparam>
+ <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>base</parameter></methodparam>
+ <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>filter</parameter></methodparam>
+ <methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>[]</initializer></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>attributes_only</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter><initializer>-1</initializer></methodparam>
- <methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer>LDAP_DEREF_NEVER</initializer></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>serverctrls</parameter><initializer>array()</initializer></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer><constant>LDAP_DEREF_NEVER</constant></initializer></methodparam>
+ <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
指定したフィルタ <parameter>filter</parameter>
@@ -29,7 +29,7 @@
</para>
<para>
<constant>LDAP_SCOPE_ONELEVEL</constant> は、コール時に指定した
- <parameter>base_dn</parameter> の直下の階層から検索した結果のみを返すことを表します
+ <parameter>base</parameter> の直下の階層から検索した結果のみを返すことを表します
("<command>ls</command>" と入力して、現在の作業ディレクトリのファイル/フォルダ
一覧を取得するのと同じようなものです)。
</para>
@@ -40,7 +40,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>link_identifier</parameter></term>
+ <term><parameter>ldap</parameter></term>
<listitem>
<para>
<function>ldap_connect</function> が返す LDAP リンク ID。
@@ -48,7 +48,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>base_dn</parameter></term>
+ <term><parameter>base</parameter></term>
<listitem>
<para>
ディレクトリのベース DN。
@@ -78,7 +78,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>attrsonly</parameter></term>
+ <term><parameter>attributes_only</parameter></term>
<listitem>
<para>
属性の型のみを取得したい場合は 1 を設定します。
@@ -158,7 +158,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>serverctrls</parameter></term>
+ <term><parameter>controls</parameter></term>
<listitem>
<para>
リクエストと一緒に送信する <link linkend="ldap.controls">LDAP コントロール</link> の配列
@@ -188,10 +188,11 @@
</row>
</thead>
<tbody>
+ &ldap.changelog.controls-nullable;
<row>
<entry>7.3</entry>
<entry>
- <parameter>serverctrls</parameter> のサポートが追加されました。
+ <parameter>controls</parameter> のサポートが追加されました。
</entry>
</row>
</tbody>
@@ -237,7 +238,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/ldap/functions/ldap-read.xml
===================================================================
--- phpdoc/ja/trunk/reference/ldap/functions/ldap-read.xml 2020-12-10 00:57:15 UTC (rev 351986)
+++ phpdoc/ja/trunk/reference/ldap/functions/ldap-read.xml 2020-12-10 01:08:52 UTC (rev 351987)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 346169 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351984 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.ldap-read" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
@@ -11,16 +11,16 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>resource</type><methodname>ldap_read</methodname>
- <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
- <methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
- <methodparam><type>string</type><parameter>filter</parameter></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>array("*")</initializer></methodparam>
- <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter><initializer>0</initializer></methodparam>
+ <type class="union"><type>resource</type><type>array</type><type>false</type></type><methodname>ldap_read</methodname>
+ <methodparam><type class="union"><type>resource</type><type>array</type></type><parameter>ldap</parameter></methodparam>
+ <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>base</parameter></methodparam>
+ <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>filter</parameter></methodparam>
+ <methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>[]</initializer></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>attributes_only</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter><initializer>-1</initializer></methodparam>
- <methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer>LDAP_DEREF_NEVER</initializer></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>serverctrls</parameter><initializer>array()</initializer></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer><constant>LDAP_DEREF_NEVER</constant></initializer></methodparam>
+ <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
指定したフィルタ <parameter>filter</parameter>
@@ -35,7 +35,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>link_identifier</parameter></term>
+ <term><parameter>ldap</parameter></term>
<listitem>
<para>
<function>ldap_connect</function> が返す LDAP リンク ID。
@@ -43,7 +43,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>base_dn</parameter></term>
+ <term><parameter>base</parameter></term>
<listitem>
<para>
ディレクトリのベース DN。
@@ -79,7 +79,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>attrsonly</parameter></term>
+ <term><parameter>attributes_only</parameter></term>
<listitem>
<para>
属性の型のみを取得したい場合は 1 を設定します。
@@ -160,7 +160,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>serverctrls</parameter></term>
+ <term><parameter>controls</parameter></term>
<listitem>
<para>
リクエストと一緒に送信する <link linkend="ldap.controls">LDAP コントロール</link> の配列
@@ -190,6 +190,7 @@
</row>
</thead>
<tbody>
+ &ldap.changelog.controls-nullable;
<row>
<entry>4.0.5</entry>
<entry>
@@ -200,7 +201,7 @@
<row>
<entry>7.3</entry>
<entry>
- <parameter>serverctrls</parameter> のサポートが追加されました。
+ <parameter>controls</parameter> のサポートが追加されました。
</entry>
</row>
</tbody>
@@ -210,7 +211,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Modified: phpdoc/ja/trunk/reference/ldap/functions/ldap-search.xml
===================================================================
--- phpdoc/ja/trunk/reference/ldap/functions/ldap-search.xml 2020-12-10 00:57:15 UTC (rev 351986)
+++ phpdoc/ja/trunk/reference/ldap/functions/ldap-search.xml 2020-12-10 01:08:52 UTC (rev 351987)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 346169 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351984 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.ldap-search" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -11,16 +11,16 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>resource</type><methodname>ldap_search</methodname>
- <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
- <methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
- <methodparam><type>string</type><parameter>filter</parameter></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>array("*")</initializer></methodparam>
- <methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter><initializer>0</initializer></methodparam>
+ <type class="union"><type>resource</type><type>array</type><type>false</type></type><methodname>ldap_search</methodname>
+ <methodparam><type class="union"><type>resource</type><type>array</type></type><parameter>ldap</parameter></methodparam>
+ <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>base</parameter></methodparam>
+ <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>filter</parameter></methodparam>
+ <methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>[]</initializer></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>attributes_only</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter><initializer>-1</initializer></methodparam>
- <methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer>LDAP_DEREF_NEVER</initializer></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>serverctrls</parameter><initializer>array()</initializer></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer><constant>LDAP_DEREF_NEVER</constant></initializer></methodparam>
+ <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
指定したフィルタを使用し、
@@ -48,7 +48,7 @@
<para>
<variablelist>
<varlistentry>
- <term><parameter>link_identifier</parameter></term>
+ <term><parameter>ldap</parameter></term>
<listitem>
<para>
<function>ldap_connect</function> が返す LDAP リンク ID。
@@ -56,7 +56,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>base_dn</parameter></term>
+ <term><parameter>base</parameter></term>
<listitem>
<para>
ディレクトリのベース DN。
@@ -92,7 +92,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>attrsonly</parameter></term>
+ <term><parameter>attributes_only</parameter></term>
<listitem>
<para>
属性の型のみを取得したい場合は 1 を設定します。
@@ -172,7 +172,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>serverctrls</parameter></term>
+ <term><parameter>controls</parameter></term>
<listitem>
<para>
リクエストと一緒に送信する <link linkend="ldap.controls">LDAP コントロール</link> の配列
@@ -202,10 +202,11 @@
</row>
</thead>
<tbody>
+ &ldap.changelog.controls-nullable;
<row>
<entry>7.3</entry>
<entry>
- <parameter>serverctrls</parameter> のサポートが追加されました。
+ <parameter>controls</parameter> のサポートが追加されました。
</entry>
</row>
</tbody>
@@ -247,7 +248,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml