Split ConsoleOutput::outputAs() into getter/setter

cakephp · Apr 10, 2017 · 360c7e5 · 360c7e5
1 parent b891683
commit 360c7e5
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 2 deletions.
diff --git a/src/Console/ConsoleIo.php b/src/Console/ConsoleIo.php
@@ -266,7 +266,7 @@ public function ask($prompt, $default = null)
      */
     public function outputAs($mode)
     {
-        $this->_out->outputAs($mode);
+        $this->_out->setOutputAs($mode);
     }
 
     /**

diff --git a/src/Console/ConsoleOutput.php b/src/Console/ConsoleOutput.php
@@ -302,9 +302,31 @@ public function styles($style = null, $definition = null)
         return true;
     }
 
+    /**
+     * Get the output type on how formatting tags are treated.
+     *
+     * @return int
+     */
+    public function getOutputAs()
+    {
+        return $this->_outputAs;
+    }
+
+    /**
+     * Set the output type on how formatting tags are treated.
+     *
+     * @param int $type The output type to use. Should be one of the class constants.
+     * @return void
+     */
+    public function setOutputAs($type)
+    {
+        $this->_outputAs = $type;
+    }
+
     /**
      * Get/Set the output type to use. The output type how formatting tags are treated.
      *
+     * @deprecated 3.5.0 Use getOutputAs()/setOutputAs() instead.
      * @param int|null $type The output type to use. Should be one of the class constants.
      * @return int|null Either null or the value if getting.
      */

diff --git a/src/Console/Shell.php b/src/Console/Shell.php
@@ -509,7 +509,7 @@ protected function _displayHelp($command)
         $format = 'text';
         if (!empty($this->args[0]) && $this->args[0] === 'xml') {
             $format = 'xml';
-            $this->_io->outputAs(ConsoleOutput::RAW);
+            $this->_io->setOutputAs(ConsoleOutput::RAW);
         } else {
             $this->_welcome();
         }

diff --git a/tests/TestCase/Console/ConsoleOutputTest.php b/tests/TestCase/Console/ConsoleOutputTest.php
@@ -249,6 +249,20 @@ public function testOutputAsPlain()
         $this->output->write('<error>Bad</error> Regular', false);
     }
 
+    /**
+     * test set plain output.
+     *
+     * @return void
+     */
+    public function testSetOutputAsPlain()
+    {
+        $this->output->setOutputAs(ConsoleOutput::PLAIN);
+        $this->output->expects($this->once())->method('_write')
+            ->with('Bad Regular');
+
+        $this->output->write('<error>Bad</error> Regular', false);
+    }
+
     /**
      * test plain output only strips tags used for formatting.
      *