@@ -47,8 +47,9 @@ endpoint for filesystem operations::
4747Mkdir
4848~~~~~
4949
50- Mkdir creates directory. On posix filesystems, directories are created with a
51- default mode value `0777 `. You can use the second argument to set your own mode::
50+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::mkdir ` creates directory.
51+ On posix filesystems, directories are created with a default mode value
52+ `0777 `. You can use the second argument to set your own mode::
5253
5354 $fs->mkdir('/tmp/photos', 0700);
5455
@@ -60,8 +61,8 @@ default mode value `0777`. You can use the second argument to set your own mode:
6061Exists
6162~~~~~~
6263
63- Exists checks for the presence of all files or directories and returns false if a
64- file is missing::
64+ :method: ` Symfony \\ Component \\ Filesystem \\ Filesystem::exists ` checks for the
65+ presence of all files or directories and returns false if a file is missing::
6566
6667 // this directory exists, return true
6768 $fs->exists('/tmp/photos');
@@ -77,9 +78,10 @@ file is missing::
7778Copy
7879~~~~
7980
80- This method is used to copy files. If the target already exists, the file is
81- copied only if the source modification date is later than the target. This
82- behavior can be overridden by the third boolean argument::
81+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::copy ` is used to copy
82+ files. If the target already exists, the file is copied only if the source
83+ modification date is later than the target. This behavior can be overridden by
84+ the third boolean argument::
8385
8486 // works only if image-ICC has been modified after image.jpg
8587 $fs->copy('image-ICC.jpg', 'image.jpg');
@@ -90,9 +92,9 @@ behavior can be overridden by the third boolean argument::
9092Touch
9193~~~~~
9294
93- Touch sets access and modification time for a file. The current time is used by
94- default. You can set your own with the second argument. The third argument is
95- the access time::
95+ :method: ` Symfony \\ Component \\ Filesystem \\ Filesystem::touch ` sets access and
96+ modification time for a file. The current time is used by default. You can set
97+ your own with the second argument. The third argument is the access time::
9698
9799 // set modification time to the current timestamp
98100 $fs->touch('file.txt');
@@ -109,8 +111,8 @@ the access time::
109111Chown
110112~~~~~
111113
112- Chown is used to change the owner of a file. The third argument is a boolean
113- recursive option::
114+ :method: ` Symfony \\ Component \\ Filesystem \\ Filesystem::chown ` is used to change
115+ the owner of a file. The third argument is a boolean recursive option::
114116
115117 // set the owner of the lolcat video to www-data
116118 $fs->chown('lolcat.mp4', 'www-data');
@@ -125,8 +127,8 @@ recursive option::
125127Chgrp
126128~~~~~
127129
128- Chgrp is used to change the group of a file. The third argument is a boolean
129- recursive option::
130+ :method: ` Symfony \\ Component \\ Filesystem \\ Filesystem::chgrp ` is used to change
131+ the group of a file. The third argument is a boolean recursive option::
130132
131133 // set the group of the lolcat video to nginx
132134 $fs->chgrp('lolcat.mp4', 'nginx');
@@ -142,8 +144,8 @@ recursive option::
142144Chmod
143145~~~~~
144146
145- Chmod is used to change the mode of a file. The fourth argument is a boolean
146- recursive option::
147+ :method: ` Symfony \\ Component \\ Filesystem \\ Filesystem::chmod ` is used to change
148+ the mode of a file. The fourth argument is a boolean recursive option::
147149
148150 // set the mode of the video to 0600
149151 $fs->chmod('video.ogg', 0600);
@@ -158,7 +160,8 @@ recursive option::
158160Remove
159161~~~~~~
160162
161- Remove let's you remove files, symlink, directories easily::
163+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::remove ` let's you remove
164+ files, symlink, directories easily::
162165
163166 $fs->remove(array('symlink', '/path/to/directory', 'activity.log'));
164167
@@ -170,7 +173,8 @@ Remove let's you remove files, symlink, directories easily::
170173Rename
171174~~~~~~
172175
173- Rename is used to rename files and directories::
176+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::rename ` is used to rename
177+ files and directories::
174178
175179 //rename a file
176180 $fs->rename('/tmp/processed_video.ogg', '/path/to/store/video_647.ogg');
@@ -180,8 +184,9 @@ Rename is used to rename files and directories::
180184symlink
181185~~~~~~~
182186
183- Creates a symbolic link from the target to the destination. If the filesystem
184- does not support symbolic links, a third boolean argument is available::
187+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::symlink ` creates a
188+ symbolic link from the target to the destination. If the filesystem does not
189+ support symbolic links, a third boolean argument is available::
185190
186191 // create a symbolic link
187192 $fs->symlink('/path/to/source', '/path/to/destination');
@@ -192,7 +197,8 @@ does not support symbolic links, a third boolean argument is available::
192197makePathRelative
193198~~~~~~~~~~~~~~~~
194199
195- Return the relative path of a directory given another one::
200+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::makePathRelative ` returns
201+ the relative path of a directory given another one::
196202
197203 // returns '../'
198204 $fs->makePathRelative(
@@ -205,14 +211,16 @@ Return the relative path of a directory given another one::
205211mirror
206212~~~~~~
207213
208- Mirrors a directory::
214+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::mirror ` mirrors a
215+ directory::
209216
210217 $fs->mirror('/path/to/source', '/path/to/target');
211218
212219isAbsolutePath
213220~~~~~~~~~~~~~~
214221
215- isAbsolutePath returns true if the given path is absolute, false otherwise::
222+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::isAbsolutePath ` returns
223+ ``true `` if the given path is absolute, false otherwise::
216224
217225 // return true
218226 $fs->isAbsolutePath('/tmp');
@@ -248,4 +256,11 @@ Whenever something wrong happens, an exception implementing
248256:class: `Symfony\\ Component\\ Filesystem\\ Exception\\ ExceptionInterface ` is
249257thrown.
250258
259+ ..note ::
260+
261+ Prior to version 2.1, ``mkdir `` returned a boolean and did not throw
262+ exceptions. As of 2.1, a
263+ :class: `Symfony\\ Component\\ Filesystem\\ Exception\\ IOException ` is thrown
264+ if a directory creation fails.
265+
251266.. _`Packagist` :https://packagist.org/packages/symfony/filesystem