Skip to content

Commit 3c9a671

Browse files
committed
minor #20031 [Finder] Add a note to the followLinks method (lkolndeep)
This PR was merged into the 5.4 branch. Discussion ---------- [Finder] Add a note to the followLinks method Add some explanations to followLinks method with a note including a little example. Commits ------- 43878c3 Add a note to explain the goal of the followLinks method
2 parents 31ced83 + 43878c3 commit 3c9a671

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

components/finder.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,10 @@ If you want to follow `symbolic links`_, use the ``followLinks()`` method::
127127

128128
$finder->files()->followLinks();
129129

130+
.. note::
131+
132+
Be careful, the ``followLinks`` method does not resolve links. This method makes the links to directories followed/traversed into. If we suppose a folder *followLinksFolder* which contains a folder with a file and a symlink of the folder *folder, file.txt and symlinkfolder*, thanks to the Finder component ``$finder->in('/home/user/followLinksFolder');`` will retrieve three elements *folder, folder/file.txt and symlinkfolder*. If, we use the ``followLinks`` method instead ``$finder->followLinks()->in('/home/user/followLinksFolder');``, we will retrieve also a fourth element *folder, folder/file.txt, symlinkfolder and symlinkfolder/file.txt*.
133+
130134
Version Control Files
131135
~~~~~~~~~~~~~~~~~~~~~
132136

0 commit comments

Comments
 (0)