minor #9407 [Process] Renamed flushOutput() and flushErrorOutput() to clearOutput() and clearErrorOutput() (bschussek)

fabpot · fabpot · commit b8ec2bfdf01b · 2013-11-09T13:03:12.000+01:00
This PR was merged into the master branch. Discussion ---------- [Process] Renamed flushOutput() and flushErrorOutput() to clearOutput() and clearErrorOutput() | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - I renamed `flushOutput()` and `flushErrorOutput()` to `clearOutput()` and `clearErrorOutput()` since I find the current naming unintuitive. When reading [the blog post about this feature](http://symfony.com/blog/new-in-symfony-2-4-flushing-stdout-and-stderr-on-a-process) I initially thought that the output would be flushed to the console (as in `ob_flush()`). Using "clear" on the other hand conforms well with [our conventions](http://symfony.com/doc/current/contributing/code/conventions.html). Commits ------- 1811367 [Process] Renamed flushOutput() and flushErrorOutput() to clearOutput() and clearErrorOutput()
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -408,7 +408,7 @@ public function getIncrementalOutput()
      *
      * @return Process
      */
-    public function flushOutput()
+    public function clearOutput()
     {
         $this->stdout = '';
         $this->incrementalOutputOffset = 0;
@@ -454,7 +454,7 @@ public function getIncrementalErrorOutput()
      *
      * @return Process
      */
-    public function flushErrorOutput()
+    public function clearErrorOutput()
     {
         $this->stderr = '';
         $this->incrementalErrorOutputOffset = 0;
diff --git a/src/Symfony/Component/Process/Tests/AbstractProcessTest.php b/src/Symfony/Component/Process/Tests/AbstractProcessTest.php
@@ -174,7 +174,7 @@ public function testFlushErrorOutput()
         $p = new Process(sprintf('php -r %s', escapeshellarg('$n = 0; while ($n < 3) { file_put_contents(\'php://stderr\', \'ERROR\'); $n++; }')));
 
         $p->run();
-        $p->flushErrorOutput();
+        $p->clearErrorOutput();
         $this->assertEmpty($p->getErrorOutput());
     }
 
@@ -202,7 +202,7 @@ public function testFlushOutput()
         $p = new Process(sprintf('php -r %s', escapeshellarg('$n=0;while ($n<3) {echo \' foo \';$n++;}')));
 
         $p->run();
-        $p->flushOutput();
+        $p->clearOutput();
         $this->assertEmpty($p->getOutput());
     }
 

Original file line number	Diff line number	Diff line change
`@@ -408,7 +408,7 @@ public function getIncrementalOutput()`
`408`	`408`	`*`
`409`	`409`	`* @return Process`
`410`	`410`	`*/`
`411`		`- public function flushOutput()`
	`411`	`+ public function clearOutput()`
`412`	`412`	`{`
`413`	`413`	`$this->stdout = '';`
`414`	`414`	`$this->incrementalOutputOffset = 0;`
`@@ -454,7 +454,7 @@ public function getIncrementalErrorOutput()`
`454`	`454`	`*`
`455`	`455`	`* @return Process`
`456`	`456`	`*/`
`457`		`- public function flushErrorOutput()`
	`457`	`+ public function clearErrorOutput()`
`458`	`458`	`{`
`459`	`459`	`$this->stderr = '';`
`460`	`460`	`$this->incrementalErrorOutputOffset = 0;`
Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,7 @@ public function testFlushErrorOutput()`
`174`	`174`	`$p = new Process(sprintf('php -r %s', escapeshellarg('$n = 0; while ($n < 3) { file_put_contents(\'php://stderr\', \'ERROR\'); $n++; }')));`
`175`	`175`
`176`	`176`	`$p->run();`
`177`		`- $p->flushErrorOutput();`
	`177`	`+ $p->clearErrorOutput();`
`178`	`178`	`$this->assertEmpty($p->getErrorOutput());`
`179`	`179`	`}`
`180`	`180`
`@@ -202,7 +202,7 @@ public function testFlushOutput()`
`202`	`202`	`$p = new Process(sprintf('php -r %s', escapeshellarg('$n=0;while ($n<3) {echo \' foo \';$n++;}')));`
`203`	`203`
`204`	`204`	`$p->run();`
`205`		`- $p->flushOutput();`
	`205`	`+ $p->clearOutput();`
`206`	`206`	`$this->assertEmpty($p->getOutput());`
`207`	`207`	`}`
`208`	`208`