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

723 Commits

Author SHA1 Message Date
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
MorganLOCode
b07b628d6f Fix typo (#5280)
Sometimes the spelling used is "writeable", sometimes it's "writable". Both are valid in English, but the SplFileInfo method is "isWritable".
2026-02-06 10:56:00 +08:00
alfsb
0a3648a718 Sync, indent and update fgetcsv escape parameter description. (#5111)
Co-authored-by: André L F S Bacci <ae@php.net>
2026-01-15 16:58:24 +00:00
alfsb
3a89b55d11 Another fgetscv proprietary description. (#5101)
Co-authored-by: André L F S Bacci <ae@php.net>
2026-01-14 21:30:54 +00:00
Máté Kocsis
aa120f36c5 Sync parameter type and name changes (#5073)
Co-authored-by: Gina Peter Banyard <girgias@php.net>
2026-01-14 22:09:32 +01:00
Louis-Arnaud
a0d6215110 Document offsetSet() as alias of deprecated SplObjectStorage::attach() (#5089)
`SplObjectStorage::offsetSet()` is an alias of `SplObjectStorage::attach()`,
which is deprecated as of PHP 8.5.

This change makes the alias relationship explicit in the documentation.
Issue: https://github.com/php/doc-en/issues/4957
2026-01-11 14:49:45 +00:00
Narkunan
e1fd0bef1d Clarify behaviour of escape parameter and how it handles enclosure bytes (#5006) 2026-01-09 12:54:39 +00:00
Máté Kocsis
c142be8117 Fix class constant references inside parameter default values (#5084) 2026-01-09 09:50:14 +01:00
Tim Düsterhus
ce98b568f8 Add &warn.deprecated.function-*; to all deprecated functions 2025-10-04 16:28:55 +02:00
Tim Düsterhus
30eb91e639 Update deprecation information in versions.xml 2025-10-04 16:21:06 +02:00
Tim Düsterhus
42d5fb01e0 Update function attributes
Generated with:

     build/gen_stub.php --replace-methodsynopses **.stub.php ../phpdoc/en/

And then manually picked the changes.
2025-10-04 16:04:02 +02:00
Mikhail Alferov
65c5581436 ArrayObject::__construct: clarify subtyping of iteratorClass parameter (#4430) 2025-02-06 12:29:31 +00:00
Mikhail Alferov
0aa6447b9d ArrayObject::__construct Replace tag and implement → extend + CS (#4416) 2025-01-27 15:15:16 +00:00
siwa32
4a0ce5d81a Update setcsvcontrol.xml Fix typo (#4379) 2025-01-12 21:04:13 +08:00
Gina Peter Banyard
e93feee287 Integrate SPL language-snippets and rearrange SPL docs (#4286)
* Integrate SPL language-snippets

They are only used once, having them as entities is useless.

* Move SPL interfaces from misc to interface page

* Rearrange SPL docs

Move ArrayObject to data structures, get rid of misc page, do not chunk introduction

* Remove interface list, the ToC shows the same info
2024-12-10 23:42:47 +00:00
Gina Peter Banyard
267a3d4e60 Move Countable to predefined interfaces out from SPL (#1664)
It has been part of core since 7.2, so let's stop lying.
2024-12-10 18:04:18 +00:00
Kamil Tekiela
52e3799c4c Change output of ArrayObject (#4239) 2024-12-04 00:12:00 +01:00
Máté Kocsis
9b1673cf11 Mark deprecated functions with the #[\Deprecated] attribute (#4161) 2024-11-27 20:38:45 +01:00
alfsb
61e2ab1eeb Fill xi:fallback to avoid 'variablelist incomplete' in some translations (#4128)
Co-authored-by: André L F S Bacci <ae@php.net>
2024-11-22 23:24:53 +00:00
Mikhail Alferov
f1eb91d07d fgetcsv(): Remove the duplicate sentence (#4111) 2024-11-20 13:29:03 +00:00
Gina Peter Banyard
73007ad988 PHP 8.4: CSV related changes and deprecations (#4093)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2024-11-19 23:11:44 +00:00
Mikhail Alferov
afb063c84d spl_autoload_call() Mention traits and enumerations (#4059) 2024-11-13 15:16:52 +00:00
Mikhail Alferov
87ea6d1675 spl_autoload(): Clarify the value passed to the class parameter of the callback (#4053) 2024-11-12 23:26:54 +00:00
Gina Peter Banyard
03674dde72 PHP-8.4: SplFixedArray::__wakeup() is deprecated 2024-11-12 18:52:27 +00:00
Gina Peter Banyard
dc6fe404e3 PHP-8.4: SplObjectStorage now implements SeekableIterator 2024-11-12 18:52:27 +00:00
Gina Peter Banyard
eb39dbdba6 PHP 8-4: SPL tentative return types 2024-11-12 18:52:27 +00:00
Gina Peter Banyard
434557c58b PHP 8.4: Document SplObjectStorage::seek() (#4048)
Co-authored-by: Niels Dossche <7771979+nielsdos@users.noreply.github.com>
2024-11-12 18:08:47 +00:00
Mikhail Alferov
077aab2687 ArrayIterator description: add tags and flesh out the description (#3933)
* Improving wording and add markup tags

* reference/spl/arrayiterator.xml Replace links with tags

Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

---------

Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2024-10-28 16:12:22 +00:00
Mikhail Alferov
ba762ce190 getiterator.xml Specify the exact classname for the new iterator (GH-3946)
* getiterator.xml Add link to Iterator interface and specify...

...the default return iterator class
2024-10-28 11:14:54 +01:00
Mikhail Alferov
da11d3f566 Update getiterator.xml Amend the example code (#3931) 2024-10-27 11:40:39 +00:00
Gina Peter Banyard
487afb0901 SPL: Remove useless constant page (#3905) 2024-10-23 17:27:25 +01:00
Christoph M. Becker
eff22719b0 Restrict discouragement of ArrayObject to wrapping objects (GH-3867)
* Restrict discouragement of ArrayObject to wrapping objects

This is a follow-up to PR #3858, based on a comment by @arnaud-lb[1].

[1] <https://github.com/php/php-src/issues/16371#issuecomment-2410928030>
2024-10-17 01:22:33 +02:00
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