minor #18195 Improved the PHPdoc of FileSystem::copy() (javiereguiluz)

nicolas-grekas · nicolas-grekas · commit 56624e6a9d1e · 2016-03-16T16:52:39.000+01:00
This PR was squashed before being merged into the 2.3 branch (closes #18195). Discussion ---------- Improved the PHPdoc of FileSystem::copy() | Q | A | ------------- | --- | Branch | 2.3+ | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #12937 | License | MIT | Doc PR | - Commits ------- 9ad67ca Improved the PHPdoc of FileSystem::copy()
diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -23,17 +23,17 @@ class Filesystem
     /**
      * Copies a file.
      *
-     * This method only copies the file if the origin file is newer than the target file.
+     * If the target file is older than the origin file, it's always overwritten.
+     * If the target file is newer, it is overwritten only when the
+     * $overwriteNewerFiles option is set to true.
      *
-     * By default, if the target already exists, it is not overridden.
-     *
-     * @param string $originFile The original filename
-     * @param string $targetFile The target filename
-     * @param bool   $override   Whether to override an existing file or not
+     * @param string $originFile          The original filename
+     * @param string $targetFile          The target filename
+     * @param bool   $overwriteNewerFiles If true, target files newer than origin files are overwritten
      *
      * @throws IOException When copy fails
      */
-    public function copy($originFile, $targetFile, $override = false)
+    public function copy($originFile, $targetFile, $overwriteNewerFiles = false)
     {
         if (stream_is_local($originFile) && !is_file($originFile)) {
             throw new IOException(sprintf('Failed to copy %s because file not exists', $originFile));
@@ -42,7 +42,7 @@ public function copy($originFile, $targetFile, $override = false)
         $this->mkdir(dirname($targetFile));
 
         $doCopy = true;
-        if (!$override && null === parse_url($originFile, PHP_URL_HOST) && is_file($targetFile)) {
+        if (!$overwriteNewerFiles && null === parse_url($originFile, PHP_URL_HOST) && is_file($targetFile)) {
             $doCopy = filemtime($originFile) > filemtime($targetFile);
         }
 
