Skip to content

Sync parameter type and name changes #5073

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

Merged
kocsismate merged 10 commits into from
Jan 14, 2026
Merged

Sync parameter type and name changes #5073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8761ce5
Sync parameter type and name changes
kocsismate Jan 3, 2026
012431f
Fix build
kocsismate Jan 3, 2026
1d7ec99
Update reference/pcntl/functions/pcntl-setcpuaffinity.xml
kocsismate Jan 6, 2026
69f3690
Update reference/pgsql/functions/pg-copy-from.xml
kocsismate Jan 6, 2026
84e0dc8
Update reference/zlib/functions/gzfile.xml
kocsismate Jan 6, 2026
086f2f1
Address review comments
kocsismate Jan 6, 2026
cdc53c3
Update reference/zlib/functions/gzopen.xml
kocsismate Jan 6, 2026
009dda6
Update reference/zlib/functions/readgzfile.xml
kocsismate Jan 6, 2026
c52c102
Apply suggestions from code review
kocsismate Jan 13, 2026
6ae0b44
Remove bogus changelog
kocsismate Jan 13, 2026
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
12 changes: 10 additions & 2 deletions reference/ldap/functions/ldap-get-option.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ldap_get_option</methodname>
<methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
<methodparam><type class="union"><type>LDAP\Connection</type><type>null</type></type><parameter>ldap</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>int</type></type><parameter role="reference">value</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
Expand All @@ -27,7 +27,9 @@
<term><parameter>ldap</parameter></term>
<listitem>
<para>
&ldap.parameter.ldap;
Either an <classname>LDAP\Connection</classname> instance, returned by
<function>ldap_connect</function>, to get the option for that connection,
or &null; to get the global option.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -242,6 +244,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
<parameter>ldap</parameter> is now nullable.
</entry>
</row>
&ldap.changelog.ldap-object;
</tbody>
</tgroup>
Expand Down
11 changes: 9 additions & 2 deletions reference/openssl/functions/openssl-cms-encrypt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter>headers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>encoding</parameter><initializer><constant>OPENSSL_ENCODING_SMIME</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cipher_algo</parameter><initializer><constant>OPENSSL_CIPHER_AES_128_CBC</constant></initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>int</type></type><parameter>cipher_algo</parameter><initializer><constant>OPENSSL_CIPHER_AES_128_CBC</constant></initializer></methodparam>
</methodsynopsis>
<para>
This function encrypts content to one or more recipients,
Expand Down Expand Up @@ -80,7 +80,7 @@
<term><parameter>cipher_algo</parameter></term>
<listitem>
<para>
A cypher to use.
A cipher to use.
</para>
</listitem>
</varlistentry>
Expand All @@ -105,6 +105,13 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
<parameter>cipher_algo</parameter> is now of type <type>int</type> or <type>string</type>.
Previously, it was of type <type>int</type>.
</entry>
</row>
<row>
<entry>8.1.0</entry>
<entry>
Expand Down
12 changes: 6 additions & 6 deletions reference/pcntl/functions/pcntl-getcpuaffinity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>bool</type><type>array</type></type><methodname>pcntl_getcpuaffinity</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>pid</parameter><initializer>&null;</initializer></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>pcntl_getcpuaffinity</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>process_id</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Retrieve the cpu affinity of the <parameter>pid</parameter>.
Retrieve the cpu affinity of the <parameter>process_id</parameter>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<term><parameter>process_id</parameter></term>
<listitem>
<simpara>
If &null;, the current process ID is used.
Expand All @@ -43,11 +43,11 @@
&reftitle.errors;
<simpara>
A <classname>ValueError</classname> is thrown when
<parameter>pid</parameter> is an invalid process id
<parameter>process_id</parameter> is an invalid process id
or the cpu mask had failed to be created.
</simpara>
<simpara>
If <parameter>pid</parameter> is a process for which the current
If <parameter>process_id</parameter> is a process for which the current
user has no allowed permission, a <constant>E_WARNING</constant>
is emitted.
</simpara>
Expand Down
16 changes: 8 additions & 8 deletions reference/pcntl/functions/pcntl-setcpuaffinity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,28 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pcntl_setcpuaffinity</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>pid</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>hmask</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>process_id</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>cpu_ids</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<simpara>
Sets the cpu affinity for the <parameter>pid</parameter> with the cpu affinity mask given by
<parameter>hmask</parameter>.
Sets the cpu affinity for the <parameter>process_id</parameter> with the cpu affinity mask given by
<parameter>cpu_ids</parameter>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>pid</parameter></term>
<term><parameter>process_id</parameter></term>
<listitem>
<simpara>
If &null;, the current process ID is used.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hmask</parameter></term>
<term><parameter>cpu_ids</parameter></term>
<listitem>
<simpara>
The cpu affinity mask comprised of one or more cpu id for binding the process to.
Expand All @@ -53,9 +53,9 @@
&reftitle.errors;
<simpara>
A <classname>TypeError</classname> is thrown if one
of the cpu id from the <parameter>hmask</parameter> is invalid.
of the cpu id from the <parameter>cpu_ids</parameter> is invalid.
A <classname>ValueError</classname> is thrown if
<parameter>pid</parameter> is an invalid process id
<parameter>process_id</parameter> is an invalid process id
or the cpu mask had failed to be created.
</simpara>
</refsect1>
Expand Down
11 changes: 9 additions & 2 deletions reference/pgsql/functions/pg-copy-from.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<type>bool</type><methodname>pg_copy_from</methodname>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>rows</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>Traversable</type></type><parameter>rows</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter><initializer>"\\\\N"</initializer></methodparam>
</methodsynopsis>
Expand Down Expand Up @@ -48,7 +48,7 @@
<term><parameter>rows</parameter></term>
<listitem>
<para>
An <type>array</type> of data to be copied into <parameter>table_name</parameter>.
An <type>iterable</type> data to be copied into <parameter>table_name</parameter>.
Each value in <parameter>rows</parameter> becomes a row in <parameter>table_name</parameter>.
Each value in <parameter>rows</parameter> should be a delimited string of the values
to insert into each field. Values should be linefeed terminated.
Expand Down Expand Up @@ -95,6 +95,13 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
<parameter>rows</parameter> is now of type <type>iterable</type>.
Previously, it was of type <type>array</type>.
</entry>
</row>
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
Expand Down
10 changes: 8 additions & 2 deletions reference/spl/splfileobject/fwrite.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<methodsynopsis role="SplFileObject">
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SplFileObject::fwrite</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Writes the contents of <parameter>data</parameter> to the file
Expand All @@ -34,7 +34,7 @@
<term><parameter>length</parameter></term>
<listitem>
<para>
If the <parameter>length</parameter> argument is given, writing will
If the <parameter>length</parameter> argument is <type>int</type>, writing will
stop after <parameter>length</parameter> bytes have been written or
the end of <parameter>data</parameter> is reached, whichever comes
first.
Expand Down Expand Up @@ -63,6 +63,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
<parameter>length</parameter> is now nullable.
</entry>
</row>
<row>
<entry>7.4.0</entry>
<entry>
Expand Down
2 changes: 1 addition & 1 deletion reference/zlib/functions/deflate_init.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<methodsynopsis>
<type class="union"><type>DeflateContext</type><type>false</type></type><methodname>deflate_init</methodname>
<methodparam><type>int</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>object</type></type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<para>
Initializes an incremental deflate context using the specified
Expand Down
37 changes: 30 additions & 7 deletions reference/zlib/functions/gzfile.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>gzfile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<para>
This function is identical to <function>readgzfile</function>, except that
it returns the file in an array.
</para>
Expand All @@ -32,11 +32,9 @@
<varlistentry>
<term><parameter>use_include_path</parameter></term>
<listitem>
<para>
You can set this optional parameter to <literal>1</literal>, if you
want to search for the file in the <link
linkend="ini.include-path">include_path</link> too.
</para>
<simpara>
If set to &true;, files in the <link linkend="ini.include-path">include_path</link> are searched for too.
</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -49,6 +47,30 @@
&return.falseforfailure;.
</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.5.0</entry>
<entry>
<parameter>use_include_path</parameter> is now of type <type>bool</type>.
Previously, it was of type <type>int</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand All @@ -67,6 +89,7 @@ foreach ($lines as $line) {
</example>
</para>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
Expand Down
34 changes: 28 additions & 6 deletions reference/zlib/functions/gzopen.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<type class="union"><type>resource</type><type>false</type></type><methodname>gzopen</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>use_include_path</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Opens a gzip (.gz) file for reading or writing.
Expand Down Expand Up @@ -52,11 +52,9 @@
<varlistentry>
<term><parameter>use_include_path</parameter></term>
<listitem>
<para>
You can set this optional parameter to <literal>1</literal>, if you
want to search for the file in the <link
linkend="ini.include-path">include_path</link> too.
</para>
<simpara>
If set to &true;, files in the <link linkend="ini.include-path">include_path</link> are searched for too.
</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -73,6 +71,30 @@
If the open fails, the function returns &false;.
</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.5.0</entry>
<entry>
<parameter>use_include_path</parameter> is now of type <type>bool</type>.
Previously, it was of type <type>int</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
2 changes: 1 addition & 1 deletion reference/zlib/functions/inflate_init.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<methodsynopsis>
<type class="union"><type>InflateContext</type><type>false</type></type><methodname>inflate_init</methodname>
<methodparam><type>int</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>object</type></type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<para>
Initialize an incremental inflate context with the specified
Expand Down
23 changes: 23 additions & 0 deletions reference/zlib/functions/readgzfile.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,29 @@
&fs.emits.warning.on.failure;
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
<parameter>use_include_path</parameter> is now of type <type>bool</type>.
Previously, it was of type <type>int</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
Expand Down