1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-24 15:52:15 +01:00
Commit Graph

708 Commits

Author SHA1 Message Date
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
Max Lyuchin
faa17c20aa Update array-key-exists.xml with deprecation notice (#5063)
Added deprecation notice for using null as key.
2025-12-30 15:41:04 -08:00
Gina Peter Banyard
b68b5e427e Markup nits for new array_first and array_last function docs 2025-11-04 06:42:38 +00:00
Niels Dossche
4ca7cdeaee array_walk: Fix misleading wording (#4960)
Since PHP8 this is no longer a warning but an actual exception.
Throw was never really right in the first place however, as warnings
are _emitted_, not _thrown_.
2025-10-30 11:01:25 +01:00
Mikhail Alferov
1f5bcc30ee array-map.xml Change the misleading wording (#4802)
* array-map.xml Change the misleading wording

Keys of input arrays are ignored. The function only considers the sequential order of elements (as determined by their internal pointers), not their indices

* Update reference/array/functions/array-map.xml

Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>

---------

Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
2025-10-16 15:14:14 +01:00
Yoshinari Takaoka
85c47f89f3 [PHP 8.5] added array_[first|last] Documentation (#4925) 2025-10-14 04:04:40 +09:00
Tisza Gergő
eaec4ab10a Fix type juggling notes for list() and array destructuring (#3680)
Update notes about the handling of missing keys and non-arrays
during array destructuring to match the behavior seen on
3v4l.org, which doesn't issue a warning or notice in some cases
where the documentation claims it does. Also update list() docs
to provide the same information.

list():
* missing key: https://3v4l.org/bYBt6
* destructuring an integer: https://3v4l.org/7lNhK
* a boolean: https://3v4l.org/p5LDd
* a string: https://3v4l.org/KHSAH
* null: https://3v4l.org/lk1iu

array notation:
* missing key: https://3v4l.org/KCiTC
* destructuring an integer: https://3v4l.org/louVG
* a boolean: https://3v4l.org/SWL5L
* a string: https://3v4l.org/aK90L
* null: https://3v4l.org/Y8cOY

Fixes #3640.
2025-08-23 22:30:09 -07:00
Luffy
f53ab502a1 Remove wddx_deserialize from extract example (#4840) 2025-08-22 10:15:42 +08:00
Derick Rethans
2e60c5134e Enable WASM for book.array, and tweak examples 2025-05-07 10:52:58 +01:00
Jakub Vrana
0e6f9948fe Fix example code style 2025-04-17 18:27:15 +02:00
Martin Samesch
73048c75fb Fix typo (#4546) 2025-03-20 21:36:19 +00:00
Russell
276c535ddd array_key_exists: Move note into changelog, make examples output friendly. (#4506) 2025-03-04 08:47:26 -08:00
Iman
5d19b00f2f Update usort.xml Fix visibility issue (#4426) 2025-01-30 12:56:30 +00:00
Mikhail Alferov
651fad6c66 array-unique.xml Remove trailing whitespace, CS examples by the way 2025-01-14 13:45:45 +00:00
Mikhail Alferov
5a79bf91dd Update array-unique.xml Add the missing comma 2025-01-14 13:45:45 +00:00
Mikhail Alferov
8bf3587d8f array-column.xml Replace array() to [], and make ex. #2 executable (#4338) 2024-12-25 23:16:09 +00:00
Mikhail Alferov
0987e913fc array-unshift.xml Change #2 output, and CS by the way (#4323) 2024-12-20 12:43:56 +00:00
Máté Kocsis
679cf93fa1 Synchronize manual with stubs for PHP 8.4 - part 1 (#4156) 2024-11-26 17:49:53 +01:00
Mikhail Alferov
75a5125c8b list.xml Change the link to the directly one (#4002) 2024-11-04 14:39:09 +00:00
David Fernández
b75863fa38 Point to bracket notation in description of list() language construct (#3957) 2024-11-04 03:17:53 +00:00
David Fernández
e784ba3c90 Point to bracket notation in description of array() language construct (#3947) 2024-11-04 03:17:10 +00:00
Joshua Rüsweg
596c11440d Add documentation for array_find RFC (#3465)
* Add `array_find` documentation

* Add `array_find_key` documentation

* Add `array_any` documentation

* Add `array_all` documentation
2024-11-04 02:57:21 +00:00
Jim Winstead
5cc10e8d90 Simplify array_replace description and add nested array example (#3809)
Based on discussion at PR #1470
2024-10-01 11:52:15 -07:00
Tim MacDonald
8859c8b96c Standardise casting spacing (#2717) 2024-09-11 14:29:15 +01:00
Markus Staab
647d5c50e3 fix typo in range() exception case description (GH-3730) 2024-09-09 15:34:19 +02:00
Mikhail Alferov
33968dfebb array-map.xml: add an explanation of the 'zip operation' term (GH-3720)
Why not add a few words about what a 'zip operation' is? Yes, the `array_map` page contains a sample code, but it does not contain a formal explanation, as far as all other doc pages. I suppose this information will be useful :-)

Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2024-09-07 09:52:00 +02:00
Mikhail Alferov
d58ee8eaaa Add a link to the explanation of the term 'symbol table' + slightly adjust the code of the examples (#3666)
* globals.xml: add a link to the explanation of the term "symbol table"

+ amend the code examples

* extract.xml: add a link to the explanation of the term "symbol table"

+ amend the code examples

* compact.xml: add a link to the explanation of the term "symbol table"

+ amend the code examples

* references.xml: add a link to the explanation of the term "symbol table"

+ amend the code examples

* Nits

---------

Co-authored-by: Gina Peter Banyard <girgias@php.net>
2024-08-25 23:22:41 +01:00
Christoph M. Becker
4acad9b77f Fix GH-3307: ksort() behavior changed since PHP 8.2 2024-08-07 22:36:46 +02:00
Christoph M. Becker
cec5275f23 Fix #3634: Mismatch between array_walk(_recursive) return type in stub and documentation 2024-08-01 17:53:34 +02:00
Mikhail Alferov
1de7b5b65f array-filter.xml: leave one: delete or unset as identical (#3593) 2024-07-26 03:48:17 +01:00
Takuya Aramaki
4a1dedc24b array_rand() may throw ValueError since 8.0 (#3230)
array_rand() throws ValueError if empty array is given or num is out of range


Co-authored-by: Gina Peter Banyard <girgias@php.net>
2024-03-05 22:33:33 +00:00
Mikhail Alferov
768876982f Fix wrong parameter name in reference to array_keys() (#3180)
The second parameter of the `array_keys()` function is `filter_value` not `search_value`
2024-02-13 17:03:45 +00:00
Niels Dossche
2ed209827b Update array_pad docs for 8.3 (#3174) 2024-02-13 16:53:23 +00:00
Gina Peter Banyard
56509d07ae Fix GH-3003 (array_udiff(): Add precision to the comparison function) (#3070) 2024-01-27 19:23:19 +00:00
Josh S
89fe795cc8 Update array_key_exists() key parameter type as of PHP 8.0.0 (#3135) 2024-01-25 13:27:45 +00:00
Sergey Panteleev
443d81b33e [PHP 8.3] Update functions (#3106)
Co-authored-by: Gina Peter Banyard <girgias@php.net>
2024-01-16 16:36:49 +03:00
George Peter Banyard
62421b98a9 range: Update for PHP 8.3 (#2801)
Co-authored-by: Tim Düsterhus <tim@bastelstu.be>
2023-10-16 17:36:01 +02:00
dreeh
58d11dfe19 Remove ZPP failure mention in array_change_key_case() (#2849)
Co-authored-by: Denny Reeh <denny.reeh@check24.de>
2023-10-10 13:13:11 +01:00
Hideki Kinjyo
e311803cd2 compact() issues an E_WARNING as of PHP 8.0 (#2776)
PHP 8.0 converted a number of notice to warnings via the "Reclassifying engine warnings" RFC:
https://wiki.php.net/rfc/engine_warnings
2023-09-19 18:42:22 +01:00
Alexandre Daubois
6b64170daa Fix GH-2631: Clarify array_diff_(u)assoc examples (#2650) 2023-08-07 15:27:29 +01:00
Alexandre Daubois
55b7203be4 Fix GH-2631: Fix examples for array diff functions (#2634) 2023-08-01 15:14:36 +01:00
LionelMallet
6b56e6f444 Improve the refpurpose of array_count_values() (#2558) 2023-07-04 21:00:40 +01:00
Dominik Ritter
71e3c74047 docs: add a reference to array_map from array_combine (#2534) 2023-06-21 21:51:47 +01:00
Máté Kocsis
f781803449 Narrow bool return types to true when possible (#2458) 2023-05-07 22:32:58 +02:00
KOSEKI Kengo
2226ad08fd Restore type juggling caution for return value of user comparison callback (#2368)
Create an XML sort.callback.description entity which contains the description of this parameter with the caution

Co-authored-by: George Peter Banyard <girgias@php.net>
2023-03-23 13:08:38 +00:00
Chuong
2ca0903429 fix: true return type for return true always function (#2154)
Various functions and method have had their return type changed to true.

Fix this and add changelog entries.

Co-authored-by: George Peter Banyard <girgias@php.net>
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2023-02-20 16:16:37 +00:00
Daniel Siepmann
3ba15fd3df Don't mention sorting but comparison (#2301)
The array_unique function doesn't sort, but compares.
It uses the same constants but terms are mixed up.
The text uses "sorting" while each constant uses "compare".

This is now streamlined in order to reduce friction while reading.
2023-02-17 20:15:38 +01:00
niemeier23
c6534cb59e Plurality grammar correction (#2275) 2023-02-08 18:09:59 +00:00
Christoph M. Becker
6d29533483 Fix GH-2156: stdClass is spelled in different cases: StdClass / stdclass
Closes GH-2157.
2023-01-10 11:56:39 +01:00
Christoph M. Becker
fea4357a0c Revert "Fixed and simplified array_replace description"
This reverts commit bb36df3ed4, which has
been committed inadvertently.
2022-12-26 15:43:51 +01:00