add options to doctrineviz command: format, binary, output-path

janalis · Jan 24, 2017 · 13ae8d0 · 13ae8d0
1 parent 21c5823
commit 13ae8d0
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,6 @@ Render a graphical representation of a Doctrine2 mapped database.
 ## To do
 
 - [ ] Add phpunit tests
-- [ ] Add output options
 - [ ] Add mongoDB support
 
 ## Installation

diff --git a/src/Command/DoctrinevizCommand.php b/src/Command/DoctrinevizCommand.php
@@ -41,6 +41,9 @@ protected function configure()
             ->setName(static::NAME)
             ->setHelp('Generates database mapping')
             ->addOption('pattern', 'p', InputOption::VALUE_OPTIONAL, 'Filter entities that match that PCRE pattern', '.*')
+            ->addOption('binary', 'b', InputOption::VALUE_OPTIONAL, 'Path to graphviz dot binary')
+            ->addOption('format', 'f', InputOption::VALUE_OPTIONAL, 'Output format', 'png')
+            ->addOption('output-path', 'o', InputOption::VALUE_OPTIONAL, 'Output path')
         ;
     }
 
@@ -137,7 +140,20 @@ public function execute(InputInterface $input, OutputInterface $output)
                 }
             }
         }
-        $graphviz = new Graphviz();
-        $graphviz->display($graph);
+        $format = $input->getOption('format', 'png');
+        $binary = $input->getOption('binary', null);
+        $path = $input->getOption('output-path', null);
+        $graphviz = new Graphviz($format, $binary);
+        if (!$path) {
+            $graphviz->display($graph);
+
+            return 0;
+        }
+        $dotted = 'dot' === $format ? (string) $graph : $graphviz->createImageData($graph);
+        if ($path) {
+            return !file_put_contents($path, $dotted);
+        }
+
+        $output->write($dotted);
     }
 }
diff --git a/src/Graphviz/Graphviz.php b/src/Graphviz/Graphviz.php
@@ -31,15 +31,18 @@ class Graphviz
     protected $format;
 
     /** @var string */
-    protected $executable;
+    protected $binary;
 
     /**
      * Graphviz constructor.
+     *
+     * @param string $format
+     * @param string $binary
      */
-    public function __construct()
+    public function __construct($format = 'png', $binary = null)
     {
-        $this->format = 'png';
-        $this->executable = 'dot'.(0 === strpos(strtoupper(PHP_OS), 'WIN') ? '.exe' : '');
+        $this->format = $format ?: 'png';
+        $this->binary = $binary ?: 'dot'.(0 === strpos(strtoupper(PHP_OS), 'WIN') ? '.exe' : '');
     }
 
     /**
@@ -59,9 +62,9 @@ public function createImageFile(Graph $graph)
         if (false === file_put_contents($tmp, (string) $graph, LOCK_EX)) {
             throw new \UnexpectedValueException('Unable to write graphviz script to temporary file');
         }
-        system(escapeshellarg($this->executable).' -T '.escapeshellarg($this->format).' '.escapeshellarg($tmp).' -o '.escapeshellarg($tmp.'.'.$this->format), $return_var);
+        system(escapeshellarg($this->binary).' -T '.escapeshellarg($this->format).' '.escapeshellarg($tmp).' -o '.escapeshellarg($tmp.'.'.$this->format), $return_var);
         if (0 !== $return_var) {
-            throw new \UnexpectedValueException('Unable to invoke "'.$this->executable.'" to create image file (code '.$return_var.')');
+            throw new \UnexpectedValueException('Unable to invoke "'.$this->binary.'" to create image file (code '.$return_var.')');
         }
         unlink($tmp);
 
@@ -161,22 +164,22 @@ public function setFormat($format)
     }
 
     /**
-     * Get executable.
+     * Get binary.
      *
      * @return string
      */
-    public function getExecutable()
+    public function getBinary()
     {
-        return $this->executable;
+        return $this->binary;
     }
 
     /**
-     * Set executable.
+     * Set binary.
      *
-     * @param string $executable
+     * @param string $binary
      */
-    public function setExecutable($executable)
+    public function setBinary($binary)
     {
-        $this->executable = $executable;
+        $this->binary = $binary;
     }
 }