Skip to content

Commit 8dfa61d

Browse files
committed
[PHP 8.1] Use an IMAP\Connection instance instead of a resource
php/doc-en@34892f8
1 parent 08c8cec commit 8dfa61d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1067
-167
lines changed

appendices/resources.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
44
<!-- CREDITS: takagi,mumumu -->
55
<appendix xml:id="resource" xmlns="http://docbook.org/ns/docbook">
66
<title>リソース型の一覧</title>
@@ -470,7 +470,7 @@
470470
<entry>
471471
<function>ftp_close</function>
472472
</entry>
473-
<entry>FTP 接続 (PHP 8.1.0 より前のバージョン)</entry>
473+
<entry>FTP 接続 (PHP 8.1.0 より前)</entry>
474474
</row>
475475
<row>
476476
<entry>gd</entry>
@@ -624,7 +624,7 @@
624624
<entry>
625625
<function>imap_close</function>
626626
</entry>
627-
<entry>Link to IMAP, POP3 server</entry>
627+
<entry>IMAP, POP3 server への接続リンク(PHP 8.1.0 より前)</entry>
628628
</row>
629629
<row>
630630
<entry>interbase blob</entry>
@@ -1624,7 +1624,7 @@
16241624
<entry>
16251625
<function>xml_parser_free</function>
16261626
</entry>
1627-
<entry>XML パーサ(PHP 8.0.0 より前のバージョン)</entry>
1627+
<entry>XML パーサ(PHP 8.0.0 より前)</entry>
16281628
</row>
16291629
<row>
16301630
<entry>zlib</entry>

language-snippets.ent

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: takagi Status: working -->
3+
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: takagi Status: working -->
44
<!-- Credits: hirokawa,haruki,shimooka,mumumu -->
55

66
<!ENTITY installation.enabled.disable 'この拡張モジュールはデフォルトで有効になっています。無効にしたい場合は、次のオプションを指定してコンパイルします。'>
@@ -974,6 +974,19 @@ dbm_identifier</parameter></term><listitem><para><function>dbmopen</function>
974974

975975
<!-- IMAP notes -->
976976

977+
<!ENTITY imap.changelog.imap-param '<row xmlns="http://docbook.org/ns/docbook">
978+
<entry>8.1.0</entry>
979+
<entry>
980+
引数 <parameter>imap</parameter> は、<classname>IMAP\Connection</classname>
981+
クラスのインスタンスを期待するようになりました。
982+
これより前のバージョンでは、&resource; が期待されていました。
983+
</entry>
984+
</row>'>
985+
986+
<!ENTITY imap.imap-parameter.imap '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
987+
imap</parameter></term><listitem><para><classname>IMAP\Connection</classname> クラスのインスタンス。</para></listitem></varlistentry>'>
988+
989+
<!-- Deprecated -->
977990
<!ENTITY imap.imap-stream.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>
978991
imap</parameter></term><listitem><para><function>imap_open</function>
979992
が返す IMAP ストリーム。</para></listitem></varlistentry>'>

reference/imap/book.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: fc870e6f972ed48069f4c7a5a449c2e843f343a7 Maintainer: takagi Status: ready -->
3+
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: takagi Status: ready -->
44
<!-- CREDITS: hirokawa,mumumu -->
55

66
<book xml:id="book.imap" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -32,6 +32,7 @@
3232
&reference.imap.setup;
3333
&reference.imap.constants;
3434
&reference.imap.reference;
35+
&reference.imap.imap.connection;
3536

3637
</book>
3738

reference/imap/functions/imap-append.xml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: e2f50c240bebc502a3d990d73633a6141f3bd9fd Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
44
<!-- Credits: mumumu -->
55
<refentry xml:id="function.imap-append" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -11,7 +11,7 @@
1111
&reftitle.description;
1212
<methodsynopsis>
1313
<type>bool</type><methodname>imap_append</methodname>
14-
<methodparam><type>resource</type><parameter>imap</parameter></methodparam>
14+
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
1515
<methodparam><type>string</type><parameter>folder</parameter></methodparam>
1616
<methodparam><type>string</type><parameter>message</parameter></methodparam>
1717
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
@@ -26,7 +26,7 @@
2626
&reftitle.parameters;
2727
<para>
2828
<variablelist>
29-
&imap.imap-stream.description;
29+
&imap.imap-parameter.imap;
3030
<varlistentry>
3131
<term><parameter>folder</parameter></term>
3232
<listitem>
@@ -88,6 +88,7 @@
8888
</row>
8989
</thead>
9090
<tbody>
91+
&imap.changelog.imap-param;
9192
<row>
9293
<entry>8.0.0</entry>
9394
<entry>
@@ -108,23 +109,23 @@
108109
<programlisting role="php">
109110
<![CDATA[
110111
<?php
111-
$stream = imap_open("{imap.example.org}INBOX.Drafts", "username", "password");
112+
$imap = imap_open("{imap.example.org}INBOX.Drafts", "username", "password");
112113
113-
$check = imap_check($stream);
114+
$check = imap_check($imap);
114115
echo "Msg Count before append: ". $check->Nmsgs . "\n";
115116
116-
imap_append($stream, "{imap.example.org}INBOX.Drafts"
117+
imap_append($imap, "{imap.example.org}INBOX.Drafts"
117118
, "From: [email protected]\r\n"
118119
. "To: [email protected]\r\n"
119120
. "Subject: test\r\n"
120121
. "\r\n"
121122
. "this is a test message, please ignore\r\n"
122123
);
123124
124-
$check = imap_check($stream);
125+
$check = imap_check($imap);
125126
echo "Msg Count after append : ". $check->Nmsgs . "\n";
126127
127-
imap_close($stream);
128+
imap_close($imap);
128129
?>
129130
]]>
130131
</programlisting>

reference/imap/functions/imap-body.xml

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: e2f50c240bebc502a3d990d73633a6141f3bd9fd Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
44
<refentry xml:id="function.imap-body" xmlns="http://docbook.org/ns/docbook">
55
<refnamediv>
66
<refname>imap_body</refname>
@@ -10,7 +10,7 @@
1010
&reftitle.description;
1111
<methodsynopsis>
1212
<type class="union"><type>string</type><type>false</type></type><methodname>imap_body</methodname>
13-
<methodparam><type>resource</type><parameter>imap</parameter></methodparam>
13+
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
1414
<methodparam><type>int</type><parameter>message_num</parameter></methodparam>
1515
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
1616
</methodsynopsis>
@@ -31,7 +31,7 @@
3131
&reftitle.parameters;
3232
<para>
3333
<variablelist>
34-
&imap.imap-stream.description;
34+
&imap.imap-parameter.imap;
3535
<varlistentry>
3636
<term><parameter>message_num</parameter></term>
3737
<listitem>
@@ -77,6 +77,24 @@
7777
&return.falseforfailure;
7878
</para>
7979
</refsect1>
80+
81+
<refsect1 role="changelog">
82+
&reftitle.changelog;
83+
<informaltable>
84+
<tgroup cols="2">
85+
<thead>
86+
<row>
87+
<entry>&Version;</entry>
88+
<entry>&Description;</entry>
89+
</row>
90+
</thead>
91+
<tbody>
92+
&imap.changelog.imap-param;
93+
</tbody>
94+
</tgroup>
95+
</informaltable>
96+
</refsect1>
97+
8098
</refentry>
8199

82100
<!-- Keep this comment at the end of the file

reference/imap/functions/imap-bodystruct.xml

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: e2f50c240bebc502a3d990d73633a6141f3bd9fd Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
44
<!-- Credits: mumumu -->
55
<refentry xml:id="function.imap-bodystruct" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -11,7 +11,7 @@
1111
&reftitle.description;
1212
<methodsynopsis>
1313
<type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_bodystruct</methodname>
14-
<methodparam><type>resource</type><parameter>imap</parameter></methodparam>
14+
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
1515
<methodparam><type>int</type><parameter>message_num</parameter></methodparam>
1616
<methodparam><type>string</type><parameter>section</parameter></methodparam>
1717
</methodsynopsis>
@@ -23,7 +23,7 @@
2323
&reftitle.parameters;
2424
<para>
2525
<variablelist>
26-
&imap.imap-stream.description;
26+
&imap.imap-parameter.imap;
2727
<varlistentry>
2828
<term><parameter>message_num</parameter></term>
2929
<listitem>
@@ -52,6 +52,24 @@
5252
<function>imap_fetchstructure</function> を参照ください。
5353
</para>
5454
</refsect1>
55+
56+
<refsect1 role="changelog">
57+
&reftitle.changelog;
58+
<informaltable>
59+
<tgroup cols="2">
60+
<thead>
61+
<row>
62+
<entry>&Version;</entry>
63+
<entry>&Description;</entry>
64+
</row>
65+
</thead>
66+
<tbody>
67+
&imap.changelog.imap-param;
68+
</tbody>
69+
</tgroup>
70+
</informaltable>
71+
</refsect1>
72+
5573
<refsect1 role="seealso">
5674
&reftitle.seealso;
5775
<para>

reference/imap/functions/imap-check.xml

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: e2f50c240bebc502a3d990d73633a6141f3bd9fd Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
44
<refentry xml:id="function.imap-check" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>imap_check</refname>
@@ -10,7 +10,7 @@
1010
&reftitle.description;
1111
<methodsynopsis>
1212
<type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_check</methodname>
13-
<methodparam><type>resource</type><parameter>imap</parameter></methodparam>
13+
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
1414
</methodsynopsis>
1515
<para>
1616
現在のメールボックスに関する情報を調べます。
@@ -20,7 +20,7 @@
2020
&reftitle.parameters;
2121
<para>
2222
<variablelist>
23-
&imap.imap-stream.description;
23+
&imap.imap-parameter.imap;
2424
</variablelist>
2525
</para>
2626
</refsect1>
@@ -62,6 +62,24 @@
6262
失敗した場合には &false; を返します。
6363
</para>
6464
</refsect1>
65+
66+
<refsect1 role="changelog">
67+
&reftitle.changelog;
68+
<informaltable>
69+
<tgroup cols="2">
70+
<thead>
71+
<row>
72+
<entry>&Version;</entry>
73+
<entry>&Description;</entry>
74+
</row>
75+
</thead>
76+
<tbody>
77+
&imap.changelog.imap-param;
78+
</tbody>
79+
</tgroup>
80+
</informaltable>
81+
</refsect1>
82+
6583
<refsect1 role="examples">
6684
&reftitle.examples;
6785
<para>
@@ -71,8 +89,8 @@
7189
<![CDATA[
7290
<?php
7391
74-
$imap_obj = imap_check($imap_stream);
75-
var_dump($imap_obj);
92+
$imap = imap_check($imap_stream);
93+
var_dump($imap);
7694
7795
?>
7896
]]>

reference/imap/functions/imap-clearflag-full.xml

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: e2f50c240bebc502a3d990d73633a6141f3bd9fd Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
44
<refentry xml:id="function.imap-clearflag-full" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<refnamediv>
66
<refname>imap_clearflag_full</refname>
@@ -10,7 +10,7 @@
1010
&reftitle.description;
1111
<methodsynopsis>
1212
<type>bool</type><methodname>imap_clearflag_full</methodname>
13-
<methodparam><type>resource</type><parameter>imap</parameter></methodparam>
13+
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
1414
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
1515
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
1616
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
@@ -25,7 +25,7 @@
2525
&reftitle.parameters;
2626
<para>
2727
<variablelist>
28-
&imap.imap-stream.description;
28+
&imap.imap-parameter.imap;
2929
<varlistentry>
3030
<term><parameter>sequence</parameter></term>
3131
<listitem>
@@ -72,6 +72,24 @@
7272
&return.success;
7373
</para>
7474
</refsect1>
75+
76+
<refsect1 role="changelog">
77+
&reftitle.changelog;
78+
<informaltable>
79+
<tgroup cols="2">
80+
<thead>
81+
<row>
82+
<entry>&Version;</entry>
83+
<entry>&Description;</entry>
84+
</row>
85+
</thead>
86+
<tbody>
87+
&imap.changelog.imap-param;
88+
</tbody>
89+
</tgroup>
90+
</informaltable>
91+
</refsect1>
92+
7593
<refsect1 role="seealso">
7694
&reftitle.seealso;
7795
<para>

0 commit comments

Comments
 (0)