691 Commits

Author SHA1 Message Date
Christoph M. Becker
3994d010e9 Discourage the use of ArrayObject (GH-3858)
See <https://github.com/php/php-src/pull/15775#issuecomment-2334813587>.
While a formal deprecation process is pending, it seems prudent to not
advertise this class any longer.
2024-10-13 14:25:54 +02:00
Jim Winstead
cef78b0fbe Add explicit warning about CSV function's escape parameter (#3765) 2024-09-23 13:59:30 -07:00
haszi
48ce43fe79 Remove empty resources pages (#3545)
Co-authored-by: haszi <haszika80@gmail.com>
2024-07-26 02:17:29 +01:00
haszi
765b2d6eec Remove empty configuration pages (#3538)
Co-authored-by: haszi <haszika80@gmail.com>
2024-07-09 22:24:55 +01:00
haszi
605553e228 Remove empty requirements pages (#3464)
Co-authored-by: haszi <haszika80@gmail.com>
2024-07-07 14:34:34 +01:00
andreicir
7586ab5177 Fix fwrite.xml data parameter mentions (#3521) 2024-07-06 07:20:46 +01:00
haszi
57d1b0df36 Remove empty installation pages (#3462)
Co-authored-by: haszi <haszika80@gmail.com>
2024-06-21 02:38:44 +01:00
Gina Peter Banyard
4d17b7b494 [skip-revcheck] Convert class markup to be compatible with DocBook 5.2
Closes GH-3415
2024-06-14 17:04:53 +01:00
Máté Kocsis
2a8b2f1c53 Sync some classsynopses with stubs (#3367)
* Sync some classsynopses with stubs

* Rename class constant container IDs

* Remove double hypens from IDs
2024-05-20 13:15:53 +01:00
Gina Peter Banyard
62126c55f1 Minor markup issue fixups 2024-04-22 13:25:39 +01:00
Máté Kocsis
d715365c09 Sync some methodsynopses with stubs (#3199)
Co-authored-by: Gina Peter Banyard <girgias@php.net>
2024-04-16 13:02:43 +02:00
haszi
61374bbe22 Change literal to constant tags 2024-04-16 10:45:49 +01:00
Mikhail Alferov
450d2085da spl-autoload.xml: added tags (#3284) 2024-04-12 16:13:17 +01:00
Mikhail Alferov
d4b762e22e spl-autoload-register.xml: added &true; variable (#3283) 2024-04-12 16:11:38 +01:00
Andrew Lyons
8230e70922 Clarify usage of Iterator::valid methods (#3292)
This commit updates the documentation for the `valid` method of the
following iterators:

- `EmptyIterator` - add a note that this will always return false
- `FilterIterator` - add a note that the value will be false until the
  pointer is advanced to the first valid element
- `IteratorIterator` - clarify that the method checks if the element is
  valid.

These now match the source.

I have checked other iterators and these seem to be correctly
documented.

It's worth noting that the `ArrayIterator::valid` method behaves
differently - it checks if the next element is valid (confirmed in
source).

The `DirectoryIterator::valid` method may also be incorrectly
documented but I am not 100% sure of this. The documentation states
that the method checks if it is a valid _file_, but I believe that the
method checks if the Iterator element is valid.
2024-03-28 22:57:53 +01:00
Gina Peter Banyard
56b0482773 Fix some See Also links for ArrayIterator 2024-02-08 13:26:07 +00:00
Gina Peter Banyard
434992eba3 Add tags/entities to generate links in ArrayObject 2023-12-16 16:48:50 +00:00
Matthew Setter
75dfe6f116 Minor grammar correction to RecursiveArrayIterator docs (#2962)
This change makes a couple of minor grammar fixes to the
RecursiveArrayIterator docs, which I found on reading through the
respective documentation, recently.
2023-11-24 02:17:59 +00:00
Johannes Kingma
5787d74ce4 fix typo (#2918) 2023-11-05 14:15:10 +08:00
Máté Kocsis
14767af0f0 Use new class synopsis markup (#2611)
Follow-up on https://github.com/php/phd/pull/77
2023-08-30 12:28:30 +01:00
Alexandre Daubois
60af8c2b74 Add mention of is_a() and instanceof in class_implements() and class_parents() pages (#2697)
Closes GH-1606
2023-08-22 13:32:41 +01:00
Alexandre Daubois
4dc3bd2b42 Fix GH-2484: Add a note about accessing dynamic properties in ArrayObject (#2652) 2023-08-07 22:15:33 +01:00
sfinktah
73c2b06c2a Improve wording of the description of ArrayIterator (#1058) 2023-08-04 17:02:02 +01:00
Alexandre Daubois
df944b2fd1 Fix GH-1702: Update SplFixedArray methods + add PHP 8.2.0 changelog entry (#2618) 2023-07-31 16:50:08 +01:00
Alexandre Daubois
ff4e9f7762 Fix GH-1144: Document second argument of IteratorIterator::__construct() (#2627) 2023-07-31 14:35:07 +01:00
Máté Kocsis
9eb4a46bba Use new class synopsis markup for interfaces (#2620) 2023-07-29 05:55:01 +01:00
Alexandre Daubois
f7e42edba8 Add a notice to spl_object_hash() return values comparison (#2607) 2023-07-28 14:16:34 +01:00
Máté Kocsis
96a8379cd8 Render interfaces according to the new PhD format (#2556)
According to https://github.com/php/phd/pull/75
2023-07-04 20:35:33 +01:00
Máté Kocsis
823dc72e74 Fixes for SplFileObject::_toString 2023-05-17 10:25:51 +02:00
George Peter Banyard
4d80769feb Update SplFileObject::_toString() after bugfix (#2023)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2023-05-16 21:47:01 +01:00
Máté Kocsis
bad9acb507 Document more true return types (#2468)
Co-authored-by: George Peter Banyard <girgias@php.net>
2023-05-15 11:30:59 +02:00
Máté Kocsis
f781803449 Narrow bool return types to true when possible (#2458) 2023-05-07 22:32:58 +02:00
KapitanOczywisty
42bd1bfed3 Replace links to __autoload (#2430) 2023-04-16 21:31:31 +01:00
KapitanOczywisty
7838e3af5a spl_autoload_register ignores throw parameter (#2429) 2023-04-16 21:03:23 +01:00
othercorey
84d643420e Delete DirectoryIterator methods that are inherited (#2350)
Move specific examples up into SplFileInfo
2023-03-27 22:16:19 +01: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
Tim Düsterhus
a7f7a21fb9 Explicitly mention that spl_autoload_register will drop any leading backslash (#2330) 2023-03-09 16:56:03 +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
Lucas Bustamante
c03200d4f9 Update getsubpathname.xml
Closes GH-2298.
2023-02-15 17:56:35 +01:00
othercorey
857bcd5c61 Drop SplFileObject::fgets() return false description (#2208) 2023-01-19 00:17:31 +00:00
Ollie Read
0181b7f927 Added changelog to reflect changed return type of spl_autoload_functions (#2217) 2023-01-19 00:12:50 +00:00
Máté Kocsis
4658c8e6ce Document the __toString() and export() related changes in ext/reflection (#2170) 2023-01-12 15:41:16 +01:00
Máté Kocsis
a0d6ceeacd Add missing class constants with empty description - part 4 (#2160) 2023-01-10 23:10:36 +01: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
Máté Kocsis
e5202c6e49 Remove unnecessary documentation (#2151)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2023-01-09 15:19:47 +01:00
Christoph M. Becker
0189a49610 Builtin subclasses of IteratorIterator don't override getInnerIterator()
Maybe they did prior to PHP 7.0.0, but that would be irrelevant now
anyway.
2022-12-30 20:43:14 +01:00
Máté Kocsis
1acd98a6cd Remove unnecessary documentation of non-existent constructors (#2122)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2022-12-28 16:34:44 +01:00
Máté Kocsis
3fc56d76de List inherited constructors on the class synopsis pages (#2090) 2022-12-28 15:51:40 +01:00
Jawira Portugal
a7d00d0b91 Update FilesystemIterator::__construct doc for php 8.2
Closes GH-2081.
2022-12-16 10:58:13 +01:00
Christoph M. Becker
071a588364 Fix xpointer expressions
When removing the `not()` operator, some closing parentheses have been
overlooked, which resulted in broken xpointer expressions.
2022-12-13 12:13:33 +01:00