Commit graph

482 commits

Author SHA1 Message Date
Christoph Michael Becker
f39bffda6b Add error section
Original patch provided by anon user.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340545 c90b9560-bf6c-de11-be94-00142212c4b1
2016-10-18 11:14:50 +00:00
Christoph Michael Becker
6ad6ddaac2 Fix example
Patch provided by Gavin Staniforth.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340477 c90b9560-bf6c-de11-be94-00142212c4b1
2016-10-14 09:37:13 +00:00
Christoph Michael Becker
e0a6752d35 Fix : SplFileObject::getCsvControl does not return the escape characters
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339699 c90b9560-bf6c-de11-be94-00142212c4b1
2016-07-22 13:35:09 +00:00
Christoph Michael Becker
f15c877695 SplFileObject::setCsvControl() accepts an $escape parameter as of PHP 5.3.0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339698 c90b9560-bf6c-de11-be94-00142212c4b1
2016-07-22 12:14:32 +00:00
Christoph Michael Becker
39c9ff81d3 Document : RecursiveDirectoryIterator with UNIX_PATHS flag doesn't work
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339658 c90b9560-bf6c-de11-be94-00142212c4b1
2016-07-13 17:19:57 +00:00
Christoph Michael Becker
6798718d38 Fix typo (by Shaunak Sontakke <shaunak.s@gmail.com>)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339623 c90b9560-bf6c-de11-be94-00142212c4b1
2016-07-10 12:14:00 +00:00
Christoph Michael Becker
114db47247 Fix method prototype
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339617 c90b9560-bf6c-de11-be94-00142212c4b1
2016-07-10 11:37:14 +00:00
Bob Weinand
8c3557271d Add caution/note regarding yield from and iterator_to_array
It's been a common source of mistake, see also https://bugs.php.net/72518

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339531 c90b9560-bf6c-de11-be94-00142212c4b1
2016-06-30 00:24:35 +00:00
Christoph Michael Becker
98979b1bf6 fixed example (by Mantas Urnieža)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338512 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-15 18:14:22 +00:00
Christoph Michael Becker
80d5ee9f13 fixed wrong return value description
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338502 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-15 14:40:12 +00:00
Thomas Punt
8265cab125 Resolve doc bug
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338453 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-10 16:49:58 +00:00
Thomas Punt
5ac268ed43 Resolve doc bug
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338452 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-10 16:44:57 +00:00
Thomas Punt
fec8254f0a Resolve doc bug
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338451 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-10 16:32:09 +00:00
Adam Harvey
41d8e7ffe4 Update version information to include PHP 7.
This was mostly done programmatically, and is likely wrong for a small number
of functions. We may have to wait for bug reports, unless someone wants to
review this by hand. Basic efforts were made to avoid adding "PHP 7" to
functions that were removed in PHP 5.x (x > 0) and PHP 7, but there are
undoubtedly still issues.

In case we're still using Docbook for PHP 8, I've uploaded the script that I
wrote to do this to GitHub at
https://github.com/LawnGnome/php-doc-version-migrator.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338406 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-04 21:40:07 +00:00
Christoph Michael Becker
e8f859e6fd spl_autoload() may throw LogicException (related to )
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337786 c90b9560-bf6c-de11-be94-00142212c4b1
2015-09-08 20:22:19 +00:00
Philip Olson
3a18df636a Expanded docs to take into account empty file names and missing files, and linked to realpath(). This deals with a user note by josef.vlk.d@gmail.com
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337752 c90b9560-bf6c-de11-be94-00142212c4b1
2015-09-04 17:42:41 +00:00
Christoph Michael Becker
f331045b68 fixed type info of flags (fixes )
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337622 c90b9560-bf6c-de11-be94-00142212c4b1
2015-08-25 11:53:45 +00:00
Christoph Michael Becker
964d208b1f iterator_count() may wind iterator beyond its end (fixes )
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337605 c90b9560-bf6c-de11-be94-00142212c4b1
2015-08-24 18:15:02 +00:00
Christoph Michael Becker
f0f896b7d4 typo fix by matthew rummler
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337313 c90b9560-bf6c-de11-be94-00142212c4b1
2015-08-06 23:31:54 +00:00
Christoph Michael Becker
0b3c7e0cf0 fixed validation error
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337232 c90b9560-bf6c-de11-be94-00142212c4b1
2015-07-23 22:16:25 +00:00
Christoph Michael Becker
5bd7acd547 added note that IteratorIterator delegates to the inner iterator (contributed
by anon user)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337231 c90b9560-bf6c-de11-be94-00142212c4b1
2015-07-23 22:12:07 +00:00
Peter Cowburn
70f45eaae2 use constructorsynopsis for SplFileObject (doc bug )
So that the constructor is not incorrectly listed
under Inherited Methods for child classes.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337074 c90b9560-bf6c-de11-be94-00142212c4b1
2015-06-28 15:04:45 +00:00
Christoph Michael Becker
a706ea6af5 fixed typos, grammar, expression
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336939 c90b9560-bf6c-de11-be94-00142212c4b1
2015-06-13 22:22:45 +00:00
Peter Cowburn
a2f3c32c3d add SplFileObject::fputcsv escape parameter (doc bug )
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336637 c90b9560-bf6c-de11-be94-00142212c4b1
2015-04-23 18:44:59 +00:00
Jeremy Mikola
5dd51e4caf Make SplFileInfo class setter documentation consistent
Adds links to referenced classes and methods and applies a similar template to both methods' documentation.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336018 c90b9560-bf6c-de11-be94-00142212c4b1
2015-02-27 21:53:57 +00:00
Jeremy Mikola
cf04609ce5 SplFileInfo class setters allow and default to base class
These methods allow (and default to) the base class. The previous documentation made it seem as if only child classes were accepted as an argument and also did not clarify the default value. That likely resulted in the following HHVM implementation difference: https://github.com/facebook/hhvm/pull/4917


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336017 c90b9560-bf6c-de11-be94-00142212c4b1
2015-02-27 21:48:00 +00:00
Peter Cowburn
a6685adf7a fix truncated comment in example
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335963 c90b9560-bf6c-de11-be94-00142212c4b1
2015-02-19 14:34:22 +00:00
Jean-Sebastien Hedde
41060e691d Anonymous contributions
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335484 c90b9560-bf6c-de11-be94-00142212c4b1
2014-12-30 12:29:17 +00:00
Karoly Negyesi
cac13376b3 Class implements works with interfaces
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335156 c90b9560-bf6c-de11-be94-00142212c4b1
2014-11-03 15:35:16 +00:00
Hannes Magnusson
9153615957 Revert r333536 Fixed version number in changelog
Revert r333311 Updated Countable::count([$mode]) to reflect newest changes

The fix for bug  was reverted, so undocumenting the changes


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335135 c90b9560-bf6c-de11-be94-00142212c4b1
2014-10-26 01:28:08 +00:00
Jean-Sebastien Hedde
1d6e98c575 While the note clearly mention that fact, the main description was misleading and could lead to potentially hard-to-detect bugs. Better mention it twice, than taking this kind of risk
-- 
Provided by anonymous 28912 (adrien.crivelli@gmail.com)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335115 c90b9560-bf6c-de11-be94-00142212c4b1
2014-10-21 18:30:49 +00:00
Joe Watkins
fb8a70ca39 bring these inline for (change wording from stack to queue)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334980 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-24 19:50:30 +00:00
Joe Watkins
edffc3f9c4 fix (change use of the word "stack" for "queue")
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334917 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-21 06:50:51 +00:00
Peter Cowburn
340b340721 fleshed out SplFileObject::fread() a bit
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334795 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-06 18:54:10 +00:00
Peter Cowburn
eba5461de9 SplFileObject::fread() not new in 5.6
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334794 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-06 18:54:05 +00:00
Simion Onea
14af302c9c Making the XML definition consistent across the entire project.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334762 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-05 07:44:07 +00:00
Adam Harvey
3bb0367cc9 Add SPLFileObject::fread(), which I somehow missed last time around.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334642 c90b9560-bf6c-de11-be94-00142212c4b1
2014-08-28 06:51:17 +00:00
Peter Cowburn
8e5b51f313 Let's use __DIR__
Patch by André Fiedler

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333665 c90b9560-bf6c-de11-be94-00142212c4b1
2014-06-01 13:10:36 +00:00
Maciej Sobaczewski
4c3829fef3 Fixed version number in changelog
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333536 c90b9560-bf6c-de11-be94-00142212c4b1
2014-05-14 10:04:08 +00:00
Adam Harvey
53baee51a0 Fix the return type of ArrayObject::serialize().
Fixes doc bug  (Wrong documeted return type fo for
ArrayObject::serialize).


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333481 c90b9560-bf6c-de11-be94-00142212c4b1
2014-05-05 17:56:36 +00:00
Levi Morrison
dbc2f48564 Fixes bug 65170
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333362 c90b9560-bf6c-de11-be94-00142212c4b1
2014-04-17 14:54:00 +00:00
Dejan Marjanovic
9905374cd0 Replace single quotes with double for (string) <initializer> unless string contains double quotes
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333317 c90b9560-bf6c-de11-be94-00142212c4b1
2014-04-14 23:48:06 +00:00
Dejan Marjanovic
7d6899caf4 Change double quotes to single based on https://github.com/php/php-src/blob/master/ext/spl/spl.php#L973
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333315 c90b9560-bf6c-de11-be94-00142212c4b1
2014-04-14 22:13:49 +00:00
Bob Weinand
754b32b63d Added string quotes on default of optional parameter for SplFileInfo::openFile()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333314 c90b9560-bf6c-de11-be94-00142212c4b1
2014-04-14 22:02:49 +00:00
Bob Weinand
3dce855d99 Updated Countable::count([$mode]) to reflect newest changes
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333311 c90b9560-bf6c-de11-be94-00142212c4b1
2014-04-13 22:20:23 +00:00
Peter Cowburn
b2f47359a2 grammar
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333199 c90b9560-bf6c-de11-be94-00142212c4b1
2014-03-29 21:55:26 +00:00
Peter Cowburn
3ecf580903 CachingIterator::getCache()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333177 c90b9560-bf6c-de11-be94-00142212c4b1
2014-03-29 21:53:53 +00:00
Peter Cowburn
f4aa62f285 Typo in example
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333172 c90b9560-bf6c-de11-be94-00142212c4b1
2014-03-29 21:53:30 +00:00
Peter Cowburn
55907a3eea Document new SplDoublyLinkedList::add()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333160 c90b9560-bf6c-de11-be94-00142212c4b1
2014-03-29 20:44:55 +00:00
Levi Morrison
a516cd8177 All iterators must be rewound before use. This one was found via bug report 62914.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333155 c90b9560-bf6c-de11-be94-00142212c4b1
2014-03-28 19:41:52 +00:00