[Console] Added a way to set terminal dimensions

symfony · Aug 9, 2013 · ce32981 · ce32981
1 parent 5cbfe30
commit ce32981
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 0 deletions.
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -66,6 +66,7 @@ class Application
     private $definition;
     private $helperSet;
     private $dispatcher;
+    private $terminalDimensions;
 
     /**
      * Constructor.
@@ -829,6 +830,10 @@ protected function getTerminalHeight()
      */
     public function getTerminalDimensions()
     {
+        if ($this->terminalDimensions) {
+            return $this->terminalDimensions;
+        }
+
         if (defined('PHP_WINDOWS_VERSION_BUILD')) {
             // extract [w, H] from "wxh (WxH)"
             if (preg_match('/^(\d+)x\d+ \(\d+x(\d+)\)$/', trim(getenv('ANSICON')), $matches)) {
@@ -854,6 +859,23 @@ public function getTerminalDimensions()
         return array(null, null);
     }
 
+    /**
+     * Sets terminal dimensions.
+     *
+     * Can be useful to force terminal dimensions for functional tests.
+     *
+     * @param integer $width  The width
+     * @param integer $height The height
+     *
+     * @return Application The current application
+     */
+    public function setTerminalDimensions($width, $height)
+    {
+        $this->terminalDimensions = array($width, $height);
+
+        return $this;
+    }
+
     /**
      * Configures the input and output instances based on the user arguments and options.
      *

diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 2.4.0
 -----
 
+ * added a way to force terminal dimensions
  * [BC BREAK] made descriptors use output instead of returning a string
 
 2.3.0

diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -792,6 +792,21 @@ public function testRunDispatchesAllEventsWithException()
         $this->assertContains('before.foo.after.caught.', $tester->getDisplay());
     }
 
+    public function testTerminalDimensions()
+    {
+        $application = new Application();
+        $originalDimensions = $application->getTerminalDimensions();
+        $this->assertCount(2, $originalDimensions);
+
+        $width = 80;
+        if ($originalDimensions[0] == $width) {
+            $width = 100;
+        }
+
+        $application->setTerminalDimensions($width, 80);
+        $this->assertSame(array($width, 80), $application->getTerminalDimensions());
+    }
+
     protected function getDispatcher()
     {
         $dispatcher = new EventDispatcher;