Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
[Finder] document array use for locations#6917
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| $finder->in(__DIR__); | ||
| Search in several locations by chaining calls to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
this no longer holds true.
I propose to merge the code examples (this one and the ones on line 80 & 89):
The location is the only mandatory criteria. It tells the finder whichdirectory to use for the search:: $finder->in(__DIR__); // search in several locations $finder->in(array(__DIR__, '/elsewhere')); $finder->in(__DIR__)->in('/elsewhere'); // use wildcard characters (it has to resolve to at least one directory path) $finder->in('src/Symfony/*/*/Resources');Exclude directories from matching with the [...]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Hmm, it's less readable...
Is it ok for you to suggest the 2 options ? See my update :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
👍 for Wouter's suggestion.
@mickaelandrieu we're including more code, with short comments to explain them, as we've found that people mostly scan to code-blocks anyways. This is a situation where this isn't ahuge win, because the text between the paragraphs is so short, but I still like.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Except for one change:
// search inside *both* directories$finder->in(array(__DIR__,'/elsewhere'));// same as above$finder->in(__DIR__)->in('/elsewhere');
This is to be clear what callingin() twice does - it does not replace the previous directory.
wouterj commentedAug 25, 2016
Thanks ,makes sense. We should still keep the reference to chaining though (e.g. when dynamically adding multiple directories), see my proposal. Status: needs work |
stof commentedAug 26, 2016
multiple calls to Thus, it is good to explain to the user what happens when calling it twice (some people might expect that it replaces the previous value entirely) |
weaverryan commentedSep 19, 2016
👍 for Wouter's version of this Status: Reviewed |
This PR was merged into the 2.7 branch.Discussion----------[Finder] document array use for locationsHi,This pull request is valid from Symfony 2.7 to 3.2-dev.The function ``Finder::in()`` accepts a string or array of string for look into multiple locations =>https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Finder/Finder.phpThe other way described is valid, but shouldn't be recommended/documented.MickaëlCommits-------bff0ce6 [Finder] document array use for locations
xabbuh commentedSep 22, 2016
Thank you@mickaelandrieu. This is now merged. I also made a little tweak suggested by@weaverryan in232ebc3. |
* 2.7: Several typo fixes Update console.rst [#6917] some tweaks after review [Finder] document array use for locations
* 2.8: Several typo fixes Several typo fixes Update console.rst [#6917] some tweaks after review [Finder] document array use for locations
* 3.1: Several typo fixes Several typo fixes Several typo fixes Update console.rst [#6917] some tweaks after review [Finder] document array use for locations
Uh oh!
There was an error while loading.Please reload this page.
Hi,
This pull request is valid from Symfony 2.7 to 3.2-dev.
The function
Finder::in()accepts a string or array of string for look into multiple locations =>https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Finder/Finder.phpThe other way described is valid, but shouldn't be recommended/documented.
Mickaël