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

Jump to bottom

Update SplFixedArray methods + add PHP 8.2.0 changelog entry #2618

Merged
merged 1 commit into from
Jul 31, 2023
Merged

Update SplFixedArray methods + add PHP 8.2.0 changelog entry #2618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions reference/spl/splfixedarray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
53 changes: 53 additions & 0 deletions reference/spl/splfixedarray/getiterator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
-->
54 changes: 54 additions & 0 deletions reference/spl/splfixedarray/jsonserialize.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
-->
54 changes: 54 additions & 0 deletions reference/spl/splfixedarray/serialize.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
-->
63 changes: 63 additions & 0 deletions reference/spl/splfixedarray/unserialize.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
-->
4 changes: 4 additions & 0 deletions reference/spl/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -933,11 +933,15 @@

<function name="splfixedarray" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::__construct" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::__serialize" from="PHP 8 &gt;= 8.2.0"/>
<function name="splfixedarray::__unserialize" from="PHP 8 &gt;= 8.2.0"/>
Girgias marked this conversation as resolved.
Show resolved Hide resolved
<function name="splfixedarray::__wakeup" from="PHP 5 &gt;= 5.5.0, PHP 7, PHP 8"/>
<function name="splfixedarray::count" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::toarray" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::fromarray" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::getIterator" from="PHP 8"/>
<function name="splfixedarray::getsize" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::jsonSerialize" from="PHP 8 &gt;= 8.1.0"/>
Girgias marked this conversation as resolved.
Show resolved Hide resolved
<function name="splfixedarray::setsize" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::offsetexists" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="splfixedarray::offsetget" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
Expand Down