Rework documentation for dir functions #4989
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Include 8.5 deprecation for passing null to use the last opened directory.
Girgias
force-pushed
the
dir-deprecations
branch
from
f808a54 to
136c097
Compare
Comment on lines
+93
to
+101
| <simpara> | ||
| Because file and directory names can be strings that PHP considers "falsy" | ||
| (e.g. a directory named <literal>"0"</literal>) and | ||
| <function>readdir</function> returns &false; when it has read all entries | ||
| in a directory one needs to use the <literal>===</literal> | ||
| <link linkend="language.operators.comparison">comparison operator</link> | ||
| to properly distinguish between a directory entry whose name is "falsy" | ||
| and having read all entries of the directory. | ||
| </simpara> |
Member
There was a problem hiding this comment.
Shouldn't this need to be a warning or a note?
Member
Author
There was a problem hiding this comment.
I guess so, maybe could even be a caution.
Comment on lines
125
to
131
| <![CDATA[ | ||
| filename: . : filetype: dir | ||
| filename: .. : filetype: dir | ||
| filename: apache : filetype: dir | ||
| filename: cgi : filetype: dir | ||
| filename: cli : filetype: dir | ||
| ]]> |
Member
There was a problem hiding this comment.
The output doesn't match the code.
Member
Author
There was a problem hiding this comment.
We can't really have any output because it might be any filesystem, that's why we use the &example.outputs.similar; entity rather than &example.outputs;.
Member
There was a problem hiding this comment.
I don't mean the file names. I meant the overal output structure is from the old example. You copied the other example without the copying the output also.
Comment on lines
-88
to
-107
| <?php | ||
| if ($handle = opendir('/path/to/files')) { | ||
| echo "Directory handle: $handle\n"; | ||
| echo "Entries:\n"; | ||
| /* This is the correct way to loop over the directory. */ | ||
| while (false !== ($entry = readdir($handle))) { | ||
| echo "$entry\n"; | ||
| } | ||
| /* This is the WRONG way to loop over the directory. */ | ||
| while ($entry = readdir($handle)) { | ||
| echo "$entry\n"; | ||
| } | ||
| closedir($handle); | ||
| } | ||
| ?> | ||
| ]]> |
Member
There was a problem hiding this comment.
You copied it from here and this didn't have the output section.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Include 8.5 deprecation for passing null to use the last opened directory.