@@ -44,8 +44,8 @@ endpoint for filesystem operations::
44
44
string, an array or any object implementing :phpclass: `Traversable ` as
45
45
the target argument.
46
46
47
- mkdir
48
- ~~~~~
47
+ `` mkdir ``
48
+ ~~~~~~~~~
49
49
50
50
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::mkdir ` creates a directory recursively.
51
51
On POSIX filesystems, directories are created with a default mode value
@@ -65,12 +65,12 @@ On POSIX filesystems, directories are created with a default mode value
65
65
.. note ::
66
66
67
67
The directory permissions are affected by the current `umask `_.
68
- Set the umask for your webserver, use PHP's :phpfunction: `umask `
68
+ Set the `` umask `` for your webserver, use PHP's :phpfunction: `umask `
69
69
function or use the :phpfunction: `chmod ` function after the
70
70
directory has been created.
71
71
72
- exists
73
- ~~~~~~
72
+ `` exists ``
73
+ ~~~~~~~~~~
74
74
75
75
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::exists ` checks for the
76
76
presence of one or more files or directories and returns ``false `` if any of
@@ -88,8 +88,8 @@ them is missing::
88
88
You can pass an array or any :phpclass: `Traversable ` object as the first
89
89
argument.
90
90
91
- copy
92
- ~~~~
91
+ `` copy ``
92
+ ~~~~~~~~
93
93
94
94
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::copy ` makes a copy of a
95
95
single file (use :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::mirror ` to
@@ -103,8 +103,8 @@ by the third boolean argument::
103
103
// image.jpg will be overridden
104
104
$filesystem->copy('image-ICC.jpg', 'image.jpg', true);
105
105
106
- touch
107
- ~~~~~
106
+ `` touch ``
107
+ ~~~~~~~~~
108
108
109
109
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::touch ` sets access and
110
110
modification time for a file. The current time is used by default. You can set
@@ -122,8 +122,8 @@ your own with the second argument. The third argument is the access time::
122
122
You can pass an array or any :phpclass: `Traversable ` object as the first
123
123
argument.
124
124
125
- chown
126
- ~~~~~
125
+ `` chown ``
126
+ ~~~~~~~~~
127
127
128
128
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::chown ` changes the owner of
129
129
a file. The third argument is a boolean recursive option::
@@ -138,8 +138,8 @@ a file. The third argument is a boolean recursive option::
138
138
You can pass an array or any :phpclass: `Traversable ` object as the first
139
139
argument.
140
140
141
- chgrp
142
- ~~~~~
141
+ `` chgrp ``
142
+ ~~~~~~~~~
143
143
144
144
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::chgrp ` changes the group of
145
145
a file. The third argument is a boolean recursive option::
@@ -154,8 +154,8 @@ a file. The third argument is a boolean recursive option::
154
154
You can pass an array or any :phpclass: `Traversable ` object as the first
155
155
argument.
156
156
157
- chmod
158
- ~~~~~
157
+ `` chmod ``
158
+ ~~~~~~~~~
159
159
160
160
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::chmod ` changes the mode or
161
161
permissions of a file. The fourth argument is a boolean recursive option::
@@ -170,8 +170,8 @@ permissions of a file. The fourth argument is a boolean recursive option::
170
170
You can pass an array or any :phpclass: `Traversable ` object as the first
171
171
argument.
172
172
173
- remove
174
- ~~~~~~
173
+ `` remove ``
174
+ ~~~~~~~~~~
175
175
176
176
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::remove ` deletes files,
177
177
directories and symlinks::
@@ -183,8 +183,8 @@ directories and symlinks::
183
183
You can pass an array or any :phpclass: `Traversable ` object as the first
184
184
argument.
185
185
186
- rename
187
- ~~~~~~
186
+ `` rename ``
187
+ ~~~~~~~~~~
188
188
189
189
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::rename ` changes the name
190
190
of a single file or directory::
@@ -194,8 +194,8 @@ of a single file or directory::
194
194
// renames a directory
195
195
$filesystem->rename('/tmp/files', '/path/to/store/files');
196
196
197
- symlink
198
- ~~~~~~~
197
+ `` symlink ``
198
+ ~~~~~~~~~~~
199
199
200
200
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::symlink ` creates a
201
201
symbolic link from the target to the destination. If the filesystem does not
@@ -207,8 +207,8 @@ support symbolic links, a third boolean argument is available::
207
207
// does not support symbolic links
208
208
$filesystem->symlink('/path/to/source', '/path/to/destination', true);
209
209
210
- readlink
211
- ~~~~~~~~
210
+ `` readlink ``
211
+ ~~~~~~~~~~~~
212
212
213
213
.. versionadded :: 3.2
214
214
@@ -242,8 +242,8 @@ Its behavior is the following::
242
242
* if ``$path `` does not exist, it returns null.
243
243
* if ``$path `` exists, it returns its absolute fully resolved final version.
244
244
245
- makePathRelative
246
- ~~~~~~~~~~~~~~~~
245
+ `` makePathRelative ``
246
+ ~~~~~~~~~~~~~~~~~~~~
247
247
248
248
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::makePathRelative ` takes two
249
249
absolute paths and returns the relative path from the second path to the first one::
@@ -256,8 +256,8 @@ absolute paths and returns the relative path from the second path to the first o
256
256
// returns 'videos/'
257
257
$filesystem->makePathRelative('/tmp/videos', '/tmp')
258
258
259
- mirror
260
- ~~~~~~
259
+ `` mirror ``
260
+ ~~~~~~~~~~
261
261
262
262
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::mirror ` copies all the
263
263
contents of the source directory into the target one (use the
@@ -266,8 +266,8 @@ files)::
266
266
267
267
$filesystem->mirror('/path/to/source', '/path/to/target');
268
268
269
- isAbsolutePath
270
- ~~~~~~~~~~~~~~
269
+ `` isAbsolutePath ``
270
+ ~~~~~~~~~~~~~~~~~~
271
271
272
272
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::isAbsolutePath ` returns
273
273
``true `` if the given path is absolute, ``false `` otherwise::
@@ -281,16 +281,18 @@ isAbsolutePath
281
281
// returns false
282
282
$filesystem->isAbsolutePath('../dir');
283
283
284
- tempnam
285
- ~~~~~~~
284
+ `` tempnam ``
285
+ ~~~~~~~~~~~
286
286
287
- :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::tempnam ` creates a temporary file with a unique filename, and returns its path, or throw an exception on failure::
287
+ :method: `Symfony\\ Component\\ Filesystem\\ Filesystem::tempnam ` creates a
288
+ temporary file with a unique filename, and returns its path, or throw an
289
+ exception on failure::
288
290
289
291
// returns a path like : /tmp/prefix_wyjgtF
290
292
$filesystem->tempnam('/tmp', 'prefix_');
291
293
292
- dumpFile
293
- ~~~~~~~~
294
+ `` dumpFile ``
295
+ ~~~~~~~~~~~~
294
296
295
297
:method: `Symfony\\ Component\\ Filesystem\\ Filesystem::dumpFile ` saves the given
296
298
contents into a file. It does this in an atomic manner: it writes a temporary
@@ -302,8 +304,8 @@ complete new file (but never a partially-written file)::
302
304
303
305
The ``file.txt `` file contains ``Hello World `` now.
304
306
305
- appendToFile
306
- ~~~~~~~~~~~~
307
+ `` appendToFile ``
308
+ ~~~~~~~~~~~~~~~~
307
309
308
310
.. versionadded :: 3.3
309
311
0 commit comments