Add a tag formatter that aligns all tag values.

Author: yunosh

src/DocBlock/Tags/Formatter/AlignFormatter.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @copyright 2017 Mike van Riel<[email protected]>
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\DocBlock\Tags\Formatter;
+
+use phpDocumentor\Reflection\DocBlock\Tag;
+use phpDocumentor\Reflection\DocBlock\Tags\Formatter;
+
+class AlignFormatter implements Formatter
+{
+    /** @var int The maximum tag name length. */
+    protected $maxLen = 0;
+
+    /**
+     * Constructor.
+     *
+     * @param Tag[] $tags All tags that should later be aligned with the formatter.
+     */
+    public function __construct(array $tags)
+    {
+        foreach ($tags as $tag) {
+            $this->maxLen = max($this->maxLen, strlen($tag->getName()));
+        }
+    }
+
+    /**
+     * Formats the given tag to return a simple plain text version.
+     *
+     * @param Tag $tag
+     *
+     * @return string
+     */
+    public function format(Tag $tag)
+    {
+        return '@' . $tag->getName() . str_repeat(' ', $this->maxLen - strlen($tag->getName()) + 1) . (string)$tag;
+    }
+}