1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00

31035 Commits

Author SHA1 Message Date
Rodrigo Primo
b3e7b16928 Sort constants sections alphabetically 2026-03-23 13:05:03 +01:00
Rodrigo Primo
f9267d3c90 PHP 8.1 | Migration guide: add IMAGETYPE_AVIF constant
Add the `IMAGETYPE_AVIF` constant to the PHP 8.1 migration guide.

The Standard section was placed at the end of the file, after Tokenizer, following the pattern used in the PHP 8.5 migration guide. I'm not sure if this is correct or not.

Refs:
* https://github.com/php/php-src/pull/7091
2026-03-23 13:05:03 +01:00
Kevin DeCapite
5744be5a4d Add strict inequality check for Suit enumeration
The paragraph above explicitly states that "cases are not intrinsically backed by a scalar value"; this example demonstrates that more clearly than the others.
2026-03-23 11:59:21 +01:00
Máté Kocsis
f7f861700c Sync stubs with the manual - part 10 (#5415) 2026-03-20 22:30:50 +01:00
PPPDUD
c2face03ee Update sessions.xml 2026-03-20 16:51:08 +01:00
Joris Berthelot
4532dcab5c Update example output in getfilename.xml (#5250)
* Update example output in getfilename.xml

This doc has been inaccurate since the release of PHP 5.3.

- PHP 5.2x: https://3v4l.org/iMEHH#v5.2.17
- PHP 5.3: https://3v4l.org/iMEHH#v5.3.0
- Recent PHP versions: https://3v4l.org/iMEHH
2026-03-20 16:49:51 +01:00
Takuya Aramaki
79c53e3fa2 Remove description about preg e modifier (#5430)
`e` modifier was removed in PHP 7.0.
It has already been removed from `pattern.modifiers.xml`:
bcb7074498
2026-03-20 09:21:14 +01:00
Ilija Tovilo
ef757b033b Add warning for disable_functions and disable_classes (#5429) 2026-03-19 16:46:07 +01:00
divinity76
a758e79c3b stream_select: Fix explanation of the microseconds behavior (#5428)
Co-authored-by: Tim Düsterhus <tim@bastelstu.be>
2026-03-19 12:29:15 +01:00
KentarouTakeda
a69d8c2c89 Fix typo: RFC 3399 -> RFC 3339 in DateTimeInterface::ATOM (#5423)
The `DATE_ATOM` constant description incorrectly references "RFC 3399"
instead of "RFC 3339" (Date and Time on the Internet: Timestamps).
2026-03-17 19:01:09 +01:00
Gina Peter Banyard
8f51247cb4 Move __sleep()/__wakeup() after __serialize()/unserialize() (#5427)
This is part of https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup
2026-03-16 14:12:11 +00:00
KentarouTakeda
f5419b6edd Fix PGSQL_TRACE_SUPPRESS_TIMESTAMPS version: 8.3.0 → 8.4.20 (#5422)
Due to a preprocessor guard typo in pgsql.stub.php
(`PQTRACE_SUPPPRESS_TIMESTAMPS` — triple P), this constant was
never registered. Fixed in php-src and will be available from
PHP 8.4.20.

php-src fix: https://github.com/php/php-src/pull/21386

For patch-version notation precedent, see MYSQLI_REFRESH_REPLICA
(Available as of PHP 8.1.2, doc-en PR #1006).
2026-03-14 11:31:04 +00:00
KentarouTakeda
5f1a92089f ext/pgsql: Update outdated PostgreSQL version requirements (#5409)
## Summary

The pgsql extension documentation references PostgreSQL versions that have been
outdated for years. The requirements page (`reference/pgsql/setup.xml`) states:

https://www.php.net/manual/en/pgsql.requirements.php

> To use PostgreSQL support, you need PostgreSQL 6.5 or later,
> PostgreSQL 8.0 or later to enable all PostgreSQL module features.

However, the actual minimum libpq versions enforced by php-src are:

| PHP version | Minimum libpq | Commit |
|---|---|---|
| PHP 8.0+ | libpq 9.1 | php/php-src@ce668c0ec6 |
| PHP 8.4+ | libpq 10.0 | php/php-src#14628 |

The "PostgreSQL 6.5" requirement has been incorrect since at least PHP 8.0.0
(released 2020-11-26), which requires libpq 9.1 via `PQlibVersion` check in
`ext/pgsql/config.m4`. As of PHP 8.4, the minimum was further raised to libpq
10.0 via `PQencryptPasswordConn` check in `build/php.m4`.

## Changes

- **setup.xml**: Update requirements to match php-src, following the same
  pattern used by ext/curl and ext/openssl (per-PHP-version listing).
- **14 function pages**: Remove notes referencing PostgreSQL versions 6.3–9.0
  that are no longer relevant given the libpq 10.0 minimum. These include
  version-gated notes for `pg_prepare`, `pg_query_params`, `pg_execute`,
  `pg_escape_string`, `pg_escape_identifier`, `pg_escape_literal`,
  `pg_client_encoding`, `pg_unescape_bytea`, `pg_result_error_field`,
  `pg_parameter_status`, `pg_lo_create`, `pg_version`, `pg_affected_rows`,
  and the general `reference.xml`.
2026-03-10 17:37:21 +00:00
KentarouTakeda
1786db6ef5 Fix IntlDateFormatter::PATTERN changelog version: 8.5.0 -> 8.4.0 (#5410)
The changelog says PATTERN was added in 8.5.0, but the constants
description on the same page says "Available as of PHP 8.4.0".

See also https://www.php.net/manual/en/migration84.constants.php
2026-03-09 08:01:56 +00:00
Máté Kocsis
0eb433f1de Add missing constant tag for $flags param of Attribute::__construct() 2026-03-08 21:16:05 +01:00
Máté Kocsis
3f82c54505 Add packagesynopsis tag for BCMath, FFI and PDO classes (#5406) 2026-03-08 21:04:48 +01:00
Máté Kocsis
37d269b8f6 Add packagesynopsis tag for objects recently converted from resource (#5405) 2026-03-08 21:04:28 +01:00
Máté Kocsis
fcd9214294 Sync return type changes (#5075) 2026-03-08 21:03:56 +01:00
Kamil Tekiela
aa79a143fb Fix doc of mysqli_get_charset (#5411) 2026-03-07 22:46:13 +00:00
武田 憲太郎
63bd68a3fd Fix duplicated constant name in IntlChar 8.4.0 changelog
The changelog entry lists PROPERTY_ID_COMPAT_MATH_START twice.
The second should be PROPERTY_ID_COMPAT_MATH_CONTINUE.

See https://www.php.net/manual/en/migration84.constants.php
2026-03-06 14:23:32 +01:00
武田 憲太郎
cdb9b8afa5 Fix wrong varname for SoapFault::$lang property
Under xml:id="soapfault.props.lang", the <varname> says "headerfault"
instead of "lang" (copy-paste error).

See https://www.php.net/manual/en/class.soapfault.php
(the rendered page shows "headerfault" twice, "lang" is missing)
2026-03-06 14:22:34 +01:00
Andrey Andreev
cd4180557a HTTP Basic auth page: Remove old IE and Netscape stuff, make it HTTP-compliant 2026-03-06 14:09:05 +01:00
lacatoire
a684294e0b Fix stream_filter_append and stream_filter_prepend parameter names
- stream_filter_append: $filtername -> $filter_name, $read_write -> $mode
- stream_filter_prepend: $filtername -> $filter_name, $read_write -> $mode
2026-03-06 13:08:49 +01:00
lacatoire
8d49e302b4 Document ValueError thrown by settype() since PHP 8.0
Add Errors/Exceptions section and changelog entry.

Fixes php/doc-en#3431
2026-03-06 13:07:44 +01:00
Louis-Arnaud Catoire
ae90ecc932 docs: fix outdated ssl:// transport description 2026-03-06 08:53:37 +01:00
Mikhail Alferov
f81bbcf9d3 Update incompatible.xml Fix a method names 2026-03-06 08:50:19 +01:00
Mikhail Alferov
048982b729 incompatible.xml Fix a method name 2026-03-06 08:50:19 +01:00
AllenJB
96b10a9885 CLI Web Server: Add a note about php --help (fixes #4587) 2026-03-06 08:46:12 +01:00
Julien Dubois
54a788ca59 Document NAN return value case. 2026-03-06 08:34:42 +01:00
Louis-Arnaud
423a1da63f Apply suggestion from @TimWolla
Co-authored-by: Tim Düsterhus <timwolla@googlemail.com>
2026-03-06 08:31:11 +01:00
Louis-Arnaud Catoire
1ada637cc8 Document underflow limitation in Randomizer::getFloat() 2026-03-06 08:31:11 +01:00
John Charman
058ea1e842 Add missing constant to json-last-error
Include JSON_ERROR_NON_BACKED_ENUM in json-last-error
2026-03-06 08:29:56 +01:00
Louis-Arnaud Catoire
6bb90d24b2 Document ValueError for empty filename in getimagesize() 2026-03-06 08:28:54 +01:00
武田 憲太郎
122d5d0969 grapheme-str-split.xml: Remove erroneous locale changelog entry 2026-03-06 08:25:23 +01:00
Christian Weiske
a4bcdd05f1 Change permissions for cloned repositories
The current user and group ID are passed passed to the docker build command
and the ownership of the cloned directories are changed to them.
This gets rid of git's "dubious ownership" error.

Without this changes I got an error:
> $ make
> docker run --rm -v :/var/www/en -w /var/www -u 1000:1000 php/doc-en
> configure.php on PHP 8.2.29, libxml 2.9.14
>
> fatal: detected dubious ownership in repository at '/var/www/doc-base'
> To add an exception for this directory, call:
>
> 	git config --global --add safe.directory /var/www/doc-base
> doc-base/temp clean up FAILED.
> make: *** [Makefile:22: xhtml] Fehler 1

Resolves: https://github.com/php/doc-en/pull/4645
2026-03-05 15:24:21 +01:00
Christian Weiske
1f3033eaee Pass full local path to docker
Passing "." as path does not work with docker 20.10.24:
> $ make
> docker run --rm -v .:/var/www/en -w /var/www -u 1000:1000 php/doc-en
> docker: Error response from daemon: create .: volume name is too short, names should be at least two alphanumeric characters.
> See 'docker run --help'.
> make: *** [Makefile:22: xhtml] Fehler 125
2026-03-05 15:24:21 +01:00
Gina Peter Banyard
ae7db14ea8 Properly revert "Fix wrong xml:id on the fieldsynopsis element of Exception::$code"
This reverts commit 6a05d92a32.

On the request of Máté to fix the build.

It might make sense to rewrite history and force push to prevent revcheck issues, but that's another debate.
2026-03-05 13:35:28 +00:00
Christian Weiske
dca2a8354f Document special handling for "&" in SimpleXml::addChild()
See the comments section for that page: https://www.php.net/manual/en/simplexmlelement.addchild.php
2026-03-05 14:33:07 +01:00
Máté Kocsis
462d2bcb3f Revert "Fix wrong xml:id on the fieldsynopsis element of Exception::$code"
This reverts commit 6a05d92a32.

The id is needed since 3c4752c0ae
2026-03-05 14:21:25 +01:00
Christian Weiske
74ef2355c5 Document ssh2_auth_pubkey() from pecl/ssh2 v1.4 (#5010)
Changelog: https://pecl.php.net/package-info.php?package=ssh2&version=1.4
2026-03-05 12:50:36 +00:00
Máté Kocsis
6a05d92a32 Fix wrong xml:id on the fieldsynopsis element of Exception::$code 2026-03-05 13:48:51 +01:00
Máté Kocsis
30bda33771 Fix missing attribute for NoDiscard 2026-03-05 13:46:32 +01:00
Michael Voříšek
28930349ca Improve SQLite createFunction example (#5374) 2026-03-02 22:55:36 +01:00
Louis-Arnaud
5b7646656e Fix return type for 5 misc functions: bool -> true (#5357)
* Fix return type for 5 functions: bool -> true

These functions always return true (or throw on error):
- finfo_close (fileinfo)
- ftp_set_option (ftp)
- libxml_set_external_entity_loader (libxml)
- shm_detach (shmop)
- array_multisort (standard)

* Add changelog entries for return type change bool -> true

* Fix changelog version: use 8.5.0 instead of entity hardcoded to 8.2.0

The &return.type.true; entity is hardcoded with version 8.2.0, but all
5 functions changed their return type from bool to true in PHP 8.5.
Replace the entity with manual changelog rows using the correct version.
2026-03-02 22:55:02 +01:00
Louis-Arnaud
7d5c74c9a5 Normalize DOM error sections to explicitly mention DOMException (#5261) 2026-03-02 22:32:36 +01:00
Daniel Scherzer
b53f03f249 DATE_ATOM: refer to RFC 3339, not 3399 (#5393)
Fixes #5386
2026-03-02 11:36:42 -08:00
Derick Rethans
1d1aad45d5 Updated to version 2026.1 (2026a) 2026-03-02 18:13:37 +00:00
dependabot[bot]
5e79ef6b69 build(deps): bump actions/upload-artifact from 6 to 7 (#5396)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-03-01 19:42:14 -08:00
Máté Kocsis
c8e3b2ccad Declare the namespace of ext/random classes (#5394) 2026-02-28 14:37:54 +00:00
KentarouTakeda
a7be7e9abb Fix typo: simparapara -> simpara in StreamBucket (#5395) 2026-02-28 13:51:10 +00:00