Tyson Andre
b4d9a0a908
Link to SplFileInfo from is_file()/file_exists() docs
...
And update the list of values that can be returned by getType based on
php 8.0 ext/standard/filestat.c
SplFileInfo is the only way to do some things, such as
1. Check for the existence of a file that may or may not be readable
without emitting a notice
that is caught by whatever error handler the project uses.
(e.g. file_exists can return false for unix sockets)
2. Check for file types such as unix sockets
(e.g. `$info->getType() === 'socket'`)
Recently, I was looking for how to check if a given path was a unix
socket and the filesystem functions didn't have any links to that
information.
Closes GH-319.
2021-01-10 13:37:52 +01:00
Tyson Andre
ed1c33aa04
Make SplFixedArray intro say it can be resized
...
SplFixedArray::setSize exists. The name is misleading.
Closes GH-293
2020-12-30 09:45:14 -05:00
Christoph Michael Becker
2550f62c6a
Fix #80543 : ArrayObject::asort() and ::ksort() expect an optional int
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352168 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-22 16:28:26 +00:00
Christoph Michael Becker
e41806c30b
Revert revision(s) 351724 from phpdoc/en/trunk:
...
Document false and null return types
Cf. <https://news-web.php.net/php.doc.cvs/17645 >.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351730 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-28 18:05:44 +00:00
Christoph Michael Becker
4754397753
Revert revision 351727 from phpdoc/en/trunk:
...
Document false and null return types
Cf. <https://news-web.php.net/php.doc.cvs/17645 >.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351729 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-28 17:58:32 +00:00
Jakub Vrana
69bd53265b
Document false and null return types
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351727 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-28 15:12:46 +00:00
Jakub Vrana
c80da7c04a
Document false and null return types
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351724 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-28 12:54:59 +00:00
Christoph Michael Becker
cf52498fe9
Fix #60776 : FilesystemIterator always uses SPL_FILE_DIR_SKIPDOTS
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351423 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-18 12:27:27 +00:00
Christoph Michael Becker
7c3c51661b
Fix ##55211: ArrayObject::getArrayObject() should only returns public properties of an object
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351422 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-18 12:20:07 +00:00
Christoph Michael Becker
b95d28e6ec
Fix return types
...
Functions which return false on failure should state that in their
signature as well.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351135 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:52:35 +00:00
Christoph Michael Becker
86e6094e86
Use canonical type names
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351133 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 15:39:04 +00:00
Christoph Michael Becker
9e0f03ac35
Proper variadics instead of pseudo variadics
...
We markup variadic parameters with the `rep=repeat` standard DocBook
attribute of `<methodparam>`, and use proper variable names instead of
using the old pseudo variable name `...`.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351129 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-02 11:17:26 +00:00
Christoph Michael Becker
53242ee662
Properly markup union types
...
Since r350738 added support for union types to our DocBook DTD, we
should use it.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351075 c90b9560-bf6c-de11-be94-00142212c4b1
2020-10-30 10:45:25 +00:00
Tyson Andre
9b80b513b6
Fix typos in spl documentation
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350777 c90b9560-bf6c-de11-be94-00142212c4b1
2020-10-05 17:53:00 +00:00
Christoph Michael Becker
7f569e1f17
Remove more changelog entries, mostly from PHP 5.3 era
...
Patch contributed by Sobak <msobaczewski@gmail.com>.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350655 c90b9560-bf6c-de11-be94-00142212c4b1
2020-09-26 14:08:59 +00:00
Christoph Michael Becker
9af43469f4
Remove more changelog entries, mostly from PHP 5.2 era
...
Patch contributed by Sobak <msobaczewski@gmail.com>.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350654 c90b9560-bf6c-de11-be94-00142212c4b1
2020-09-26 13:52:31 +00:00
Christoph Michael Becker
be5b0f33a1
Remove more changelog entries, mostly from PHP 5.1 era
...
Patch contributed by Sobak <msobaczewski@gmail.com>.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350653 c90b9560-bf6c-de11-be94-00142212c4b1
2020-09-26 13:45:57 +00:00
Christoph Michael Becker
5236d760ce
Fix #79993 : SplFileObject::flock has LOCK_NB as a valid operation
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350338 c90b9560-bf6c-de11-be94-00142212c4b1
2020-08-18 23:26:40 +00:00
Christoph Michael Becker
846e28ea1b
SplFileObject: fix links in the seealso section
...
Patch contributed by Fabien Villepinte.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350079 c90b9560-bf6c-de11-be94-00142212c4b1
2020-06-23 21:57:57 +00:00
Peter Cowburn
bbe604e700
Add note on behavior of ArrayIterator::offsetUnset when used on current iteration index
...
Patch by Alex Dowad.
Closes php/doc-en#118
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350025 c90b9560-bf6c-de11-be94-00142212c4b1
2020-06-10 09:49:43 +00:00
Christoph Michael Becker
e327c1e70d
Add missing changelog entry
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349909 c90b9560-bf6c-de11-be94-00142212c4b1
2020-05-18 06:48:04 +00:00
Christoph Michael Becker
6683589b3e
Fix #79607 : Wrong return type
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349901 c90b9560-bf6c-de11-be94-00142212c4b1
2020-05-17 10:58:29 +00:00
Nikita Popov
7af1f7fa46
SPLObjectStorage: fix class version nr
...
Patch by jrfnl.
Closes php/doc-en#88 .
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349773 c90b9560-bf6c-de11-be94-00142212c4b1
2020-05-10 18:34:24 +00:00
Christoph Michael Becker
a16c2cda70
Fix #79168 : Missing __construct
method documentation in SPL Exceptions
...
Patch provided by carusogabriel@php.net .
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349537 c90b9560-bf6c-de11-be94-00142212c4b1
2020-03-27 23:03:28 +00:00
Christoph Michael Becker
9c4ad008de
SplDoublyLinkedList implements Serializable
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349321 c90b9560-bf6c-de11-be94-00142212c4b1
2020-03-05 13:41:37 +00:00
Christoph Michael Becker
4998e7c97b
Fix #78130 : Add SplPriorityQueue::isCorrupted version
...
Introduced via http://git.php.net/?p=php-src.git;a=commit;h=c54045a1f949 ,
documented via http://svn.php.net/viewvc?view=revision&revision=343928 but
never added to `versions.xml`
Patch provided by Gabriel Caruso.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349233 c90b9560-bf6c-de11-be94-00142212c4b1
2020-02-16 22:20:38 +00:00
Pieter Hordijk
4491cca51d
Fixed description about the advantage.
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@348936 c90b9560-bf6c-de11-be94-00142212c4b1
2020-01-17 15:37:07 +00:00
Yoshinari Takaoka
1a81ebd0f9
fixed changelog parameter name that follows parameter list description.
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@348831 c90b9560-bf6c-de11-be94-00142212c4b1
2020-01-07 11:23:49 +00:00
Christoph Michael Becker
929cec1734
Clarify that fgetss() is stateful
...
We also add related functionality in the see-also section.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@348386 c90b9560-bf6c-de11-be94-00142212c4b1
2019-12-01 13:03:14 +00:00
Christoph Michael Becker
04d92dac21
Fix #78462 : Wrong return type for ArrayIterator::unserialize
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347910 c90b9560-bf6c-de11-be94-00142212c4b1
2019-09-01 09:16:26 +00:00
Nikita Popov
81a88c05eb
Fix bug #65269 : SplFileObject::__construct() throws LogicException as well
...
Fix for [bug 65269](https://bugs.php.net/bug.php?id=65269 ).
Patch by BenMorel.
Closes GH-3.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347670 c90b9560-bf6c-de11-be94-00142212c4b1
2019-06-26 07:56:15 +00:00
Nikita Popov
4a414d4676
Clarify what NoRewindIterator does
...
NoRewindIterator does not forbid rewinds, it ignores them.
Patch by nikic.
Closes GH-2.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347593 c90b9560-bf6c-de11-be94-00142212c4b1
2019-06-11 21:54:08 +00:00
George Peter Banyard
6776e9012b
Fix See Also link
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347575 c90b9560-bf6c-de11-be94-00142212c4b1
2019-06-08 14:55:04 +00:00
Craig Duncan
e298f1eaee
Add changelog for SplFileObject::__toString()
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347527 c90b9560-bf6c-de11-be94-00142212c4b1
2019-06-02 15:17:21 +00:00
Craig Duncan
2abaae34ef
SplFileObject::__toString() is now an alias for SplFileObject::fgets()
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347521 c90b9560-bf6c-de11-be94-00142212c4b1
2019-06-01 10:51:29 +00:00
Christoph Michael Becker
bba432fb39
Fix #78044 : Wrong return type in ArrayIterator::getFlags() description
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347452 c90b9560-bf6c-de11-be94-00142212c4b1
2019-05-21 08:46:05 +00:00
Christoph Michael Becker
34f49a945c
Fix #78013 : SplDoublyLinkedList class constants definitions are missed
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347439 c90b9560-bf6c-de11-be94-00142212c4b1
2019-05-18 08:50:57 +00:00
Pieter Hordijk
a10c57aa99
Added example and a note to make it clear to not use a space character between file extensions in the list. Closes #67701
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347422 c90b9560-bf6c-de11-be94-00142212c4b1
2019-05-15 11:57:07 +00:00
Peter Cowburn
4f3c8fa26e
remove duplicate word
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347364 c90b9560-bf6c-de11-be94-00142212c4b1
2019-05-01 19:40:43 +00:00
George Peter Banyard
54a8931302
Fix Doc Bug #77925
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347299 c90b9560-bf6c-de11-be94-00142212c4b1
2019-04-20 14:33:20 +00:00
George Peter Banyard
87b1f7ef55
Improve sprintf documentation and related functions (such as printf)
...
Fix Doc Bug #77451
Integrate Note 111201 into doc http://php.net/manual/en/function.sprintf.php#111201
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347041 c90b9560-bf6c-de11-be94-00142212c4b1
2019-03-24 16:30:33 +00:00
Christoph Michael Becker
650d6ae781
Fix #77723 : Wrong return type for SplFileInfo::__toString
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346989 c90b9560-bf6c-de11-be94-00142212c4b1
2019-03-11 12:06:23 +00:00
Levi Morrison
13f8760951
Fix IteratorIterator::key() return type
...
Years ago this was `void`, and I erroneously changed it to `scalar`. It will delegate to the sub-iterator's get_current_key handler, which can return any kind of zval.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346694 c90b9560-bf6c-de11-be94-00142212c4b1
2019-02-04 01:49:54 +00:00
Christoph Michael Becker
3dc2583ada
SplPriorityQueue::insert() return true
...
Based on a patch provided by Jaap van Otterdijk.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346662 c90b9560-bf6c-de11-be94-00142212c4b1
2019-01-28 10:38:22 +00:00
Christoph Michael Becker
8f828979a0
As of PHP 7.4.0 an empty escape string means no escaping
...
Cf. <https://github.com/php/php-src/pull/3515 >.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346346 c90b9560-bf6c-de11-be94-00142212c4b1
2018-12-15 15:15:12 +00:00
Christoph Michael Becker
2a85fbcd7c
Fix #77271 : PHP 7.3: Various info missing from changelog/migration guide
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346281 c90b9560-bf6c-de11-be94-00142212c4b1
2018-12-10 15:24:21 +00:00
Christoph Michael Becker
dd09ee01d8
Use already defined entities instead of repeating ourselves
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345853 c90b9560-bf6c-de11-be94-00142212c4b1
2018-10-19 14:51:45 +00:00
Christoph Michael Becker
f381911905
Remove prototype from alias docs
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345852 c90b9560-bf6c-de11-be94-00142212c4b1
2018-10-19 14:43:17 +00:00
Christoph Michael Becker
3b8a1b9c99
Fix return types
...
Since ::__toString() is documented as alias of ::current(), we use the same return
types. Obviously, this doesn't make sense, though, see <https://bugs.php.net/77024 >.
Patch provided by an anonymous user.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345849 c90b9560-bf6c-de11-be94-00142212c4b1
2018-10-19 13:03:49 +00:00
Gabriel Caruso
b08ad23265
Fix Bug #76924 : CallbackFilterIterator::accept returns a boolean not a string
...
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345684 c90b9560-bf6c-de11-be94-00142212c4b1
2018-09-23 17:09:15 +00:00