feature #37479 [HttpFoundation] Added File::getContent() (lyrixx)

fabpot · fabpot · commit a4550dac6aab · 2020-07-15T14:24:15.000+02:00
This PR was merged into the 5.2-dev branch. Discussion ---------- [HttpFoundation] Added File::getContent() | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | | License | MIT | Doc PR | --- This is a very simple PR but I think it increases the DX when working with uploaded files: I looked at for this method and I did not found it. So I had to check witch method returns the "pathname" or to remember I can cast the object to string to get its pathname. It's a small detail, but IMHO it's better with it. About file_get_contents vs stream: let's be simple here. If one want a stream, they can use the code they always used for it :) Commits ------- 50d5167 [HttpFoundation] Added File::getContent()
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * added `HeaderUtils::parseQuery()`: it does the same as `parse_str()` but preserves dots in variable names
+ * added `File::getContent()`
 
 5.1.0
 -----
diff --git a/src/Symfony/Component/HttpFoundation/File/File.php b/src/Symfony/Component/HttpFoundation/File/File.php
@@ -104,6 +104,17 @@ public function move(string $directory, string $name = null)
         return $target;
     }
 
+    public function getContent(): string
+    {
+        $content = file_get_contents($this->getPathname());
+
+        if (false === $content) {
+            throw new FileException(sprintf('Could not get the content of the file "%s".', $this->getPathname()));
+        }
+
+        return $content;
+    }
+
     /**
      * @return self
      */
diff --git a/src/Symfony/Component/HttpFoundation/Tests/File/FileTest.php b/src/Symfony/Component/HttpFoundation/Tests/File/FileTest.php
@@ -85,6 +85,13 @@ public function testMoveWithNewName()
         @unlink($targetPath);
     }
 
+    public function testGetContent()
+    {
+        $file = new File(__FILE__);
+
+        $this->assertStringEqualsFile(__FILE__, $file->getContent());
+    }
+
     public function getFilenameFixtures()
     {
         return [

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,13 @@ public function testMoveWithNewName()`
`85`	`85`	`@unlink($targetPath);`
`86`	`86`	`}`
`87`	`87`
	`88`	`+ public function testGetContent()`
	`89`	`+ {`
	`90`	`+ $file = new File(__FILE__);`
	`91`	`+`
	`92`	`+ $this->assertStringEqualsFile(__FILE__, $file->getContent());`
	`93`	`+ }`
	`94`	`+`
`88`	`95`	`public function getFilenameFixtures()`
`89`	`96`	`{`
`90`	`97`	`return [`