File tree Expand file tree Collapse file tree 1 file changed +8
-3
lines changed
Expand file tree Collapse file tree 1 file changed +8
-3
lines changed Original file line number Diff line number Diff line change @@ -431,13 +431,18 @@ public function makePathRelative($endPath, $startPath)
431431 /**
432432 * Mirrors a directory to another.
433433 *
434+ * Copies files and directories from the origin directory into the target directory. By default:
435+ *
436+ * - existing files in the target directory will be overwritten, except if they are newer (see the `override` option)
437+ * - files in the target directory that do not exist in the source directory will not be deleted (see the `delete` option)
438+ *
434439 * @param string $originDir The origin directory
435440 * @param string $targetDir The target directory
436- * @param \Traversable $iterator A Traversable instance
441+ * @param \Traversable $iterator Iterator that filters which files and directories to copy
437442 * @param array $options An array of boolean options
438443 * Valid options are:
439- * - $options['override'] Whether to override an existing file on copy or not (see copy())
440- * - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink())
444+ * - $options['override'] If true, target files newer than origin files are overwritten (see copy(), defaults to false )
445+ * - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false )
441446 * - $options['delete'] Whether to delete files that are not in the source directory (defaults to false)
442447 *
443448 * @throws IOException When file type is unknown
You can’t perform that action at this time.
0 commit comments