Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PHP 8.4] Document some SPL changes in PHP-8.4 #233

Merged
merged 2 commits into from
Dec 29, 2024
+193 −31
Merged

[PHP 8.4] Document some SPL changes in PHP-8.4 #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c66bdbf
spl系の翻訳
Ippey Dec 29, 2024
cc1c860
空行を原文とあわせる対応
KentarouTakeda Dec 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 35 additions & 15 deletions reference/spl/splfixedarray/setsize.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 03674dde72012054d8e7d34d97ce9f10aef24bd5 Maintainer: takagi Status: ready -->
<refentry xml:id="splfixedarray.setsize" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplFixedArray::setSize</refname>
Expand All @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SplFixedArray">
<modifier>public</modifier> <type>bool</type><methodname>SplFixedArray::setSize</methodname>
<modifier>public</modifier> <type>true</type><methodname>SplFixedArray::setSize</methodname>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -41,21 +41,41 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<simpara>
&return.true.always;
</simpara>
</refsect1>


<refsect1 role="errors"><!-- {{{ -->

<refsect1 role="errors">
&reftitle.errors;
<para>
<parameter>size</parameter> が負の数である場合に <classname>InvalidArgumentException</classname> をスローします。
</para>
<para>
<parameter>size</parameter> を数値として解釈できない場合に <constant>E_WARNING</constant> が発生します。
</para>
</refsect1><!-- }}} -->
<simpara>
<parameter>size</parameter> が0未満の場合、
<exceptionname>ValueError</exceptionname> をスローします。
</simpara>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
<methodname>SplFixedArray::setSize</methodname> は
現在、暫定的に <type>true</type> を返しています。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>


<refsect1 role="examples">
Expand Down
29 changes: 28 additions & 1 deletion reference/spl/splfixedarray/wakeup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 03674dde72012054d8e7d34d97ce9f10aef24bd5 Maintainer: takagi Status: ready -->
<refentry xml:id="splfixedarray.wakeup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SplFixedArray::__wakeup</refname>
<refpurpose>アンシリアライズ後に配列を再初期化する</refpurpose>
</refnamediv>

<refsynopsisdiv>
&warn.deprecated.function-8-4-0;
</refsynopsisdiv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SplFixedArray">
Expand All @@ -29,6 +33,29 @@
&return.void;
</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.4.0</entry>
<entry>
このメソッドは非推奨となりました。
<methodname>SplFixedArray::__unserialize</methodname> を代わりに使ってください。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
27 changes: 25 additions & 2 deletions reference/spl/splheap/insert.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f781803449007bb0e3a96c693e0eee067f7eb466 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 03674dde72012054d8e7d34d97ce9f10aef24bd5 Maintainer: takagi Status: ready -->
<refentry xml:id="splheap.insert" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplHeap::insert</refname>
Expand Down Expand Up @@ -41,7 +41,30 @@
&return.true.always;
</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.4.0</entry>
<entry>
<methodname>SplHeap::insert</methodname> は
現在、暫定的に <type>true</type> を返しています。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
33 changes: 28 additions & 5 deletions reference/spl/splheap/recoverfromcorruption.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 03674dde72012054d8e7d34d97ce9f10aef24bd5 Maintainer: takagi Status: ready -->
<refentry xml:id="splheap.recoverfromcorruption" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplHeap::recoverFromCorruption</refname>
Expand All @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SplHeap">
<modifier>public</modifier> <type>bool</type><methodname>SplHeap::recoverFromCorruption</methodname>
<modifier>public</modifier> <type>true</type><methodname>SplHeap::recoverFromCorruption</methodname>
<void/>
</methodsynopsis>
</refsect1>
Expand All @@ -22,9 +22,32 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
常に &true; を返します。
</para>
<simpara>
&return.true.always;
</simpara>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
<methodname>SplHeap::recoverFromCorruption</methodname> は
現在、暫定的に <type>true</type> を返しています。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

</refentry>
Expand Down
27 changes: 25 additions & 2 deletions reference/spl/splobjectstorage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14767af0f05dffa6fdb9b49e1a1f4e9ca7022a60 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 03674dde72012054d8e7d34d97ce9f10aef24bd5 Maintainer: takagi Status: ready -->
<reference xml:id="class.splobjectstorage" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

<title>SplObjectStorage クラス</title>
Expand Down Expand Up @@ -34,7 +34,7 @@
</oointerface>

<oointerface>
<interfacename>Iterator</interfacename>
<interfacename>SeekableIterator</interfacename>
</oointerface>

<oointerface>
Expand Down Expand Up @@ -136,6 +136,29 @@ array(3) {
</section>
<!-- }}} -->

<section role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
以前は <interfacename>Iterator</interfacename> を実装していましたが、
<interfacename>SeekableIterator</interfacename> を実装しました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

</partintro>

&reference.spl.entities.splobjectstorage;
Expand Down
25 changes: 24 additions & 1 deletion reference/spl/splpriorityqueue/insert.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: bad9acb50797346b072f9ff6addf05ee6c385570 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 03674dde72012054d8e7d34d97ce9f10aef24bd5 Maintainer: takagi Status: ready -->
<refentry xml:id="splpriorityqueue.insert" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplPriorityQueue::insert</refname>
Expand Down Expand Up @@ -51,6 +51,29 @@
</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.4.0</entry>
<entry>
<methodname>SplPriorityQueue::insert</methodname> は
現在、暫定的に <type>true</type> を返しています。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
33 changes: 28 additions & 5 deletions reference/spl/splpriorityqueue/recoverfromcorruption.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 03674dde72012054d8e7d34d97ce9f10aef24bd5 Maintainer: takagi Status: ready -->
<refentry xml:id="splpriorityqueue.recoverfromcorruption" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplPriorityQueue::recoverFromCorruption</refname>
Expand All @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SplPriorityQueue">
<modifier>public</modifier> <type>bool</type><methodname>SplPriorityQueue::recoverFromCorruption</methodname>
<modifier>public</modifier> <type>true</type><methodname>SplPriorityQueue::recoverFromCorruption</methodname>
<void/>
</methodsynopsis>
</refsect1>
Expand All @@ -22,9 +22,32 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
常に &true; を返します。
</para>
<simpara>
&return.true.always;
</simpara>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
<methodname>SplPriorityQueue::recoverFromCorruption</methodname> は
現在、暫定的に <type>true</type> を返しています。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

</refentry>
Expand Down