[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] [doc-en] master: Fix GH-1702: Update `SplFixedArray` methods + add PHP 8.2.0 changelog ent
From: Alexandre Daubois via GitHub <noreply () php ! net>
Date: 2023-07-31 15:48:32
Message-ID: wzlYWJ0wZYLkB0K1trCr9661HRfH6S13hI4xVi8Q8Tk () main ! php ! net
[Download RAW message or body]
Author: Alexandre Daubois (alexandre-daubois)
Committer: GitHub (web-flow)
Pusher: Girgias
Date: 2023-07-31T16:50:08+01:00
Commit: https://github.com/php/doc-en/commit/df944b2fd1d2a2a2e819b9f6d7012c6c27b0ac7a
Raw diff: https://github.com/php/doc-en/commit/df944b2fd1d2a2a2e819b9f6d7012c6c27b0ac7a.diff
Fix GH-1702: Update `SplFixedArray` methods + add PHP 8.2.0 changelog entry (#2618)
Changed paths:
A reference/spl/splfixedarray/getiterator.xml
A reference/spl/splfixedarray/jsonserialize.xml
A reference/spl/splfixedarray/serialize.xml
A reference/spl/splfixedarray/unserialize.xml
M reference/spl/splfixedarray.xml
M reference/spl/versions.xml
Diff:
diff --git a/reference/spl/splfixedarray.xml b/reference/spl/splfixedarray.xml
index a486513f098..12d3ec714f1 100644
--- a/reference/spl/splfixedarray.xml
+++ b/reference/spl/splfixedarray.xml
@@ -72,6 +72,14 @@
</row>
</thead>
<tbody>
+ <row>
+ <entry>8.2.0</entry>
+ <entry>
+ The <methodname>SplFixedArray::__serialize</methodname> and
+ <methodname>SplFixedArray::__unserialize</methodname>
+ magic methods have been added to <classname>SplFixedArray</classname>.
+ </entry>
+ </row>
<row>
<entry>8.1.0</entry>
<entry>
diff --git a/reference/spl/splfixedarray/getiterator.xml \
b/reference/spl/splfixedarray/getiterator.xml new file mode 100644
index 00000000000..a414dca4221
--- /dev/null
+++ b/reference/spl/splfixedarray/getiterator.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="splfixedarray.getiterator" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>SplFixedArray::getIterator</refname>
+ <refpurpose>Retrieve the iterator to go through the array</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis role="SplFixedArray">
+ <modifier>public</modifier> \
<type>Iterator</type><methodname>SplFixedArray::getIterator</methodname> + <void/>
+ </methodsynopsis>
+ <para>
+ Returns the iterator to go through the array.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ An instance of an object implementing <classname>Iterator</classname> to go
+ through the array.
+ </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
+-->
diff --git a/reference/spl/splfixedarray/jsonserialize.xml \
b/reference/spl/splfixedarray/jsonserialize.xml new file mode 100644
index 00000000000..7c849627b61
--- /dev/null
+++ b/reference/spl/splfixedarray/jsonserialize.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="splfixedarray.jsonserialize" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>SplFixedArray::jsonSerialize</refname>
+ <refpurpose>Returns a representation that can be converted to JSON</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis role="SplFixedArray">
+ <modifier>public</modifier> \
<type>mixed</type><methodname>SplFixedArray::jsonSerialize</methodname> + <void/>
+ </methodsynopsis>
+ <para>
+ Serializes the array to a value that can be serialized natively by
+ <function>json_encode</function>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns array data which can be serialized by <function>json_encode</function>,
+ which is a value of any type other than a &resource;.
+ </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
+-->
diff --git a/reference/spl/splfixedarray/serialize.xml \
b/reference/spl/splfixedarray/serialize.xml new file mode 100644
index 00000000000..a1db009b860
--- /dev/null
+++ b/reference/spl/splfixedarray/serialize.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="splfixedarray.serialize" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>SplFixedArray::__serialize</refname>
+ <refpurpose>Serializes the SplFixedArray object</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis role="SplFixedArray">
+ <modifier>public</modifier> \
<type>array</type><methodname>SplFixedArray::__serialize</methodname> + <void/>
+ </methodsynopsis>
+ <para>
+
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </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
+-->
diff --git a/reference/spl/splfixedarray/unserialize.xml \
b/reference/spl/splfixedarray/unserialize.xml new file mode 100644
index 00000000000..ce428327d48
--- /dev/null
+++ b/reference/spl/splfixedarray/unserialize.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="splfixedarray.unserialize" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>SplFixedArray::__unserialize</refname>
+ <refpurpose>Deserializes the <parameter>data</parameter> parameter into an \
SplFixedArray object</refpurpose> + </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis role="SplFixedArray">
+ <modifier>public</modifier> \
<type>void</type><methodname>SplFixedArray::__unserialize</methodname> + \
<methodparam><type>array</type><parameter>data</parameter></methodparam> + \
</methodsynopsis> + <para>
+
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ The value being deserialized.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </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
+-->
diff --git a/reference/spl/versions.xml b/reference/spl/versions.xml
index 10ce3d1e730..9468a4f1084 100644
--- a/reference/spl/versions.xml
+++ b/reference/spl/versions.xml
@@ -933,11 +933,15 @@
<function name="splfixedarray" from="PHP 5 >= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::__construct" from="PHP 5 >= 5.3.0, PHP 7, PHP \
8"/> + <function name="splfixedarray::__serialize" from="PHP 8 >= 8.2.0"/>
+ <function name="splfixedarray::__unserialize" from="PHP 8 >= 8.2.0"/>
<function name="splfixedarray::__wakeup" from="PHP 5 >= 5.5.0, PHP 7, PHP 8"/>
<function name="splfixedarray::count" from="PHP 5 >= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::toarray" from="PHP 5 >= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::fromarray" from="PHP 5 >= 5.3.0, PHP 7, PHP 8"/>
+ <function name="splfixedarray::getIterator" from="PHP 8"/>
<function name="splfixedarray::getsize" from="PHP 5 >= 5.3.0, PHP 7, PHP 8"/>
+ <function name="splfixedarray::jsonSerialize" from="PHP 8 >= 8.1.0"/>
<function name="splfixedarray::setsize" from="PHP 5 >= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::offsetexists" from="PHP 5 >= 5.3.0, PHP 7, PHP \
8"/> <function name="splfixedarray::offsetget" from="PHP 5 >= 5.3.0, PHP 7, PHP \
8"/>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic