8000 minor #30065 [Filesystem] Fixed some docblocks and typos (samnela) · symfony/symfony@034cd46 · GitHub
[go: up one dir, main page]
Skip to content
8000

Commit 034cd46

Browse files
nicolas-grekasnicolas-grekas
committed
minor #30065 [Filesystem] Fixed some docblocks and typos (samnela)
This PR was merged into the 3.4 branch. Discussion ---------- [Filesystem] Fixed some docblocks and typos | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Commits ------- 972b971 [Filesystem] Fixed some docblocks and typos
2 parents 9e52e23 + 972b971 commit 034cd46

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

‎src/Symfony/Component/Filesystem/Exception/IOExceptionInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ interface IOExceptionInterface extends ExceptionInterface
2121
/**
2222
* Returns the associated path for the exception.
2323
*
24-
* @return string The path
24+
* @return string|null The path
2525
*/
2626
public function getPath();
2727
}

‎src/Symfony/Component/Filesystem/Filesystem.php

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,8 @@ public function exists($files)
137137
* Sets access and modification time of file.
138138
*
139139
* @param string|iterable $files A filename, an array of files, or a \Traversable instance to create
140-
* @param int $time The touch time as a Unix timestamp
141-
* @param int $atime The access time as a Unix timestamp
140+
* @param int|null $time The touch time as a Unix timestamp, if not supplied the current system time is used
141+
* @param int|null $atime The access time as a Unix timestamp, if not supplied the current system time is used
142142
*
143143
* @throws IOException When touch fails
144144
*/
@@ -193,7 +193,7 @@ public function remove($files)
193193
* @param int $umask The mode mask (octal)
194194
* @param bool $recursive Whether change the mod recursively or not
195195
*
196-
* @throws IOException When the change fail
196+
* @throws IOException When t 10000 he change fails
197197
*/
198198
public function chmod($files, $mode, $umask = 0000, $recursive = false)
199199
{
@@ -214,7 +214,7 @@ public function chmod($files, $mode, $umask = 0000, $recursive = false)
214214
* @param string $user The new owner user name
215215
* @param bool $recursive Whether change the owner recursively or not
216216
*
217-
* @throws IOException When the change fail
217+
* @throws IOException When the change fails
218218
*/
219219
public function chown($files, $user, $recursive = false)
220220
{
@@ -241,7 +241,7 @@ public function chown($files, $user, $recursive = false)
241241
* @param string $group The group name
242242
* @param bool $recursive Whether change the group recursively or not
243243
*
244-
* @throws IOException When the change fail
244+
* @throws IOException When the change fails
245245
*/
246246
public function chgrp($files, $group, $recursive = false)
247247
{
@@ -519,14 +519,14 @@ public function makePathRelative($endPath, $startPath)
519519
* - existing files in the target directory will be overwritten, except if they are newer (see the `override` option)
520520
* - files in the target directory that do not exist in the source directory will not be deleted (see the `delete` option)
521521
*
522-
* @param string $originDir The origin directory
523-
* @param string $targetDir The target directory
524-
* @param \Traversable $iterator Iterator that filters which files and directories to copy
525-
* @param array $options An array of boolean options
526-
* Valid options are:
527-
* - $options['override'] If true, target files newer than origin files are overwritten (see copy(), defaults to false)
528-
* - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false)
529-
* - $options['delete'] Whether to delete files that are not in the source directory (defaults to false)
522+
* @param string $originDir The origin directory
523+
* @param string $targetDir The target directory
524+
* @param \Traversable|null $iterator Iterator that filters which files and directories to copy, if null a recursive iterator is created
525+
* @param array $options An array of boolean options
526+
* Valid options are:
527+
* - $options['override'] If true, target files newer than origin files are overwritten (see copy(), defaults to false)
528+
* - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false)
529+
* - $options['delete'] Whether to delete files that are not in the source directory (defaults to false)
530530
*
531531
* @throws IOException When file type is unknown
532532
*/

0 commit comments

Comments
 (0)
0