[Filesystem] Add third argument $lockFile to Filesystem::appendToFile()

fwolfsjaeger · nicolas-grekas · commit 1519828e44cb · 2021-10-28T15:39:27.000+02:00
diff --git a/src/Symfony/Component/Filesystem/CHANGELOG.md b/src/Symfony/Component/Filesystem/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `Path` class
+ * Add `$lock` argument to `Filesystem::appendToFile()`
 
 5.0.0
 -----
diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -692,10 +692,11 @@ public function dumpFile(string $filename, $content)
      * Appends content to an existing file.
      *
      * @param string|resource $content The content to append
+     * @param bool            $lock    Whether the file should be locked when writing to it
      *
      * @throws IOException If the file is not writable
      */
-    public function appendToFile(string $filename, $content)
+    public function appendToFile(string $filename, $content/*, bool $lock = false*/)
     {
         if (\is_array($content)) {
             throw new \TypeError(sprintf('Argument 2 passed to "%s()" must be string or resource, array given.', __METHOD__));
@@ -707,7 +708,9 @@ public function appendToFile(string $filename, $content)
             $this->mkdir($dir);
         }
 
-        if (false === self::box('file_put_contents', $filename, $content, \FILE_APPEND)) {
+        $lock = \func_num_args() > 2 && func_get_arg(2);
+
+        if (false === self::box('file_put_contents', $filename, $content, \FILE_APPEND | ($lock ? \LOCK_EX : 0))) {
             throw new IOException(sprintf('Failed to write file "%s": ', $filename).self::$lastError, 0, null, $filename);
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -692,10 +692,11 @@ public function dumpFile(string $filename, $content)`
`692`	`692`	`* Appends content to an existing file.`
`693`	`693`	`*`
`694`	`694`	`* @param string\|resource $content The content to append`
	`695`	`+ * @param bool $lock Whether the file should be locked when writing to it`
`695`	`696`	`*`
`696`	`697`	`* @throws IOException If the file is not writable`
`697`	`698`	`*/`
`698`		`- public function appendToFile(string $filename, $content)`
	`699`	`+ public function appendToFile(string $filename, $content/, bool $lock = false/)`
`699`	`700`	`{`
`700`	`701`	`if (\is_array($content)) {`
`701`	`702`	`throw new \TypeError(sprintf('Argument 2 passed to "%s()" must be string or resource, array given.', __METHOD__));`
`@@ -707,7 +708,9 @@ public function appendToFile(string $filename, $content)`
`707`	`708`	`$this->mkdir($dir);`
`708`	`709`	`}`
`709`	`710`
`710`		`- if (false === self::box('file_put_contents', $filename, $content, \FILE_APPEND)) {`
	`711`	`+ $lock = \func_num_args() > 2 && func_get_arg(2);`
	`712`	`+`
	`713`	`+ if (false === self::box('file_put_contents', $filename, $content, \FILE_APPEND \| ($lock ? \LOCK_EX : 0))) {`
`711`	`714`	`throw new IOException(sprintf('Failed to write file "%s": ', $filename).self::$lastError, 0, null, $filename);`
`712`	`715`	`}`
`713`	`716`	`}`