php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Sync newly added parameters (#5074)

Browse Source 
Co-authored-by: Gina Peter Banyard <girgias@php.net>
This commit is contained in:
Máté Kocsis
2026-01-15 18:24:26 +01:00
committed by GitHub
parent bfa3348034
commit 9a8c593c09
16 changed files with 297 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
language-snippets.ent
View File

@@ -1289,6 +1289,15 @@ Passing untrusted data to this parameter is <emphasis>insecure</emphasis>, unles
<!ENTITY intl.property.example 'Testing different properties'>
<!ENTITY intl.param.grapheme.locale '<simpara>Locale to use.</simpara>'>
<!ENTITY intl.changelog.grapheme.locale '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.5.0</entry>
<entry>
The optional parameter <parameter>locale</parameter> has been added.
</entry>
</row>'>
<!-- LDAP notes -->
<!ENTITY ldap.parameter.ldap 'An <classname xmlns="http://docbook.org/ns/docbook">LDAP\Connection</classname> instance, returned by <function xmlns="http://docbook.org/ns/docbook">ldap_connect</function>.'>

23
reference/intl/grapheme/grapheme-str-split.xml
View File

@@ -42,6 +42,12 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
@@ -60,6 +66,23 @@
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&intl.changelog.grapheme.locale;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>

13
reference/intl/grapheme/grapheme-stripos.xml
View File

@@ -13,6 +13,7 @@
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Find position (in grapheme units) of first occurrence of a case-insensitive string
@@ -51,18 +52,23 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the position as an integer. If <parameter>needle</parameter> is not found, <function>grapheme_stripos</function> will return &false;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
@@ -74,6 +80,7 @@
</row>
</thead>
<tbody>
&intl.changelog.grapheme.locale;
<row>
<entry>7.1.0</entry>
<entry>

24
reference/intl/grapheme/grapheme-stristr.xml
View File

@@ -13,6 +13,7 @@
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>beforeNeedle</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Returns part of <parameter>haystack</parameter> string starting from and including the first occurrence of case-insensitive needle to the end of <parameter>haystack</parameter>.
@@ -48,6 +49,12 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@@ -59,6 +66,23 @@
Returns the portion of <parameter>haystack</parameter>, or &false; if <parameter>needle</parameter> is not found.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&intl.changelog.grapheme.locale;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

13
reference/intl/grapheme/grapheme-strpos.xml
View File

@@ -13,6 +13,7 @@
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Find position (in grapheme units) of first occurrence of a string
@@ -51,18 +52,23 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the position as an integer. If <parameter>needle</parameter> is not found, <function>grapheme_strpos</function> will return &false;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
@@ -74,6 +80,7 @@
</row>
</thead>
<tbody>
&intl.changelog.grapheme.locale;
<row>
<entry>7.1.0</entry>
<entry>

29
reference/intl/grapheme/grapheme-strripos.xml
View File

@@ -13,6 +13,7 @@
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Find position (in grapheme units) of last occurrence of a case-insensitive string
@@ -50,18 +51,40 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the position as an integer. If <parameter>needle</parameter> is not found, <function>grapheme_strripos</function> will return &false;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&intl.changelog.grapheme.locale;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>

29
reference/intl/grapheme/grapheme-strrpos.xml
View File

@@ -13,6 +13,7 @@
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Find position (in grapheme units) of last occurrence of a string
@@ -50,18 +51,40 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the position as an integer. If <parameter>needle</parameter> is not found, <function>grapheme_strrpos</function> will return &false;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&intl.changelog.grapheme.locale;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>

29
reference/intl/grapheme/grapheme-strstr.xml
View File

@@ -13,6 +13,7 @@
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>beforeNeedle</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Returns part of haystack string from the first occurrence of needle to the end of haystack (including the needle).
@@ -48,18 +49,40 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the portion of <parameter>haystack</parameter>, or &false; if <parameter>needle</parameter> is not found.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&intl.changelog.grapheme.locale;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>

11
reference/intl/grapheme/grapheme-substr.xml
View File

@@ -13,6 +13,7 @@
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Return part of a string
@@ -57,11 +58,16 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
&intl.param.grapheme.locale;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -80,6 +86,7 @@
</row>
</thead>
<tbody>
&intl.changelog.grapheme.locale;
<row>
<entry>8.0.0</entry>
<entry>

15
reference/openssl/functions/openssl-private-decrypt.xml
View File

@@ -14,6 +14,7 @@
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter role="reference">decrypted_data</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>padding</parameter><initializer><constant>OPENSSL_PKCS1_PADDING</constant></initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>digest_algo</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>openssl_private_decrypt</function> decrypts
@@ -65,6 +66,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>digest_algo</parameter></term>
<listitem>
<simpara>
The digest algorithm for OEAP padding, or &null; to use the default algorithm.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@@ -87,6 +96,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
The optional parameter <parameter>digest_algo</parameter> has been added.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>

15
reference/openssl/functions/openssl-public-encrypt.xml
View File

@@ -14,6 +14,7 @@
<methodparam><type>string</type><parameter role="reference">encrypted_data</parameter></methodparam>
<methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>public_key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>padding</parameter><initializer><constant>OPENSSL_PKCS1_PADDING</constant></initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>digest_algo</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>openssl_public_encrypt</function> encrypts <parameter>data</parameter>
@@ -68,6 +69,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>digest_algo</parameter></term>
<listitem>
<simpara>
The digest algorithm for OEAP padding, or &null; to use the default algorithm.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@@ -90,6 +99,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
The optional parameter <parameter>digest_algo</parameter> has been added.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>

13
reference/openssl/functions/openssl-sign.xml
View File

@@ -14,6 +14,7 @@
<methodparam><type>string</type><parameter role="reference">signature</parameter></methodparam>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>int</type></type><parameter>algorithm</parameter><initializer><constant>OPENSSL_ALGO_SHA1</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>padding</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>openssl_sign</function> computes a signature for the
@@ -67,6 +68,12 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>padding</parameter></term>
<listitem>
<simpara>RSA PSS padding to use.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@@ -89,6 +96,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
The optional parameter <parameter>padding</parameter> has been added.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>

13
reference/openssl/functions/openssl-verify.xml
View File

@@ -14,6 +14,7 @@
<methodparam><type>string</type><parameter>signature</parameter></methodparam>
<methodparam><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>public_key</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>int</type></type><parameter>algorithm</parameter><initializer><constant>OPENSSL_ALGO_SHA1</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>padding</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>openssl_verify</function> verifies that the
@@ -67,6 +68,12 @@ MIIBCgK...</literal>)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>padding</parameter></term>
<listitem>
<simpara>RSA PSS padding to use.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@@ -90,6 +97,12 @@ MIIBCgK...</literal>)
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
The optional parameter <parameter>padding</parameter> has been added.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>

16
reference/soap/soapclient/dorequest.xml
View File

@@ -15,6 +15,7 @@
<methodparam><type>string</type><parameter>action</parameter></methodparam>
<methodparam><type>int</type><parameter>version</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>oneWay</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>uriParserClass</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Performs SOAP request over HTTP.
@@ -70,6 +71,15 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>uriParserClass</parameter></term>
<listitem>
<simpara>
The classname to use for parsing the redirection URI when a <literal>"Location"</literal> header is received in the response,
or &null; to use the default, <function>parse_url</function> based parsing.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@@ -92,6 +102,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
The optional parameter <parameter>uriParserClass</parameter> has been added.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>

32
reference/soap/soapfault/construct.xml
View File

@@ -16,6 +16,7 @@
<methodparam choice="opt"><type>mixed</type><parameter>details</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>name</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>headerFault</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lang</parameter><initializer>""</initializer></methodparam>
</constructorsynopsis>
<para>
This class is used to send SOAP fault responses from the PHP handler.
@@ -78,10 +79,41 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lang</parameter></term>
<listitem>
<simpara>
The human language that the SoapFault is written in. This is only used for SOAP version 1.2.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</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>
The optional parameter <parameter>lang</parameter> has been added
in order to be compliant with the SOAP 1.2 specification.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

30
reference/soap/soapserver/fault.xml
View File

@@ -15,6 +15,7 @@
<methodparam choice="opt"><type>string</type><parameter>actor</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>details</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>name</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lang</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Sends a response to the client of the current request indicating an error.
@@ -70,6 +71,12 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lang</parameter></term>
<listitem>
<simpara>The human language that the SoapFault is written in. This is only used for SOAP version 1.2.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@@ -81,6 +88,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.5.0</entry>
<entry>
The optional parameter <parameter>lang</parameter> has been added
in order to be compliant with the SOAP 1.2 specification.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>