comparison vendor/squizlabs/php_codesniffer/CodeSniffer/DocGenerators/Markdown.php @ 0:4c8ae668cc8c

Initial import (non-working)

+<?php
+/**
+ * A doc generator that outputs documentation in Markdown format.
+ *
+ * PHP version 5
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Stefano Kowalke <[e-mail]>
+ * @copyright 2014 Arroba IT
+ * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ * @link      http://pear.php.net/package/PHP_CodeSniffer
+ */
+
+if (class_exists('PHP_CodeSniffer_DocGenerators_Generator', true) === false) {
+    throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_DocGenerators_Generator not found');
+}
+
+/**
+ * A doc generator that outputs documentation in Markdown format.
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Stefano Kowalke <[e-mail]>
+ * @copyright 2014 Arroba IT
+ * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ * @version   Release: @package_version@
+ * @link      http://pear.php.net/package/PHP_CodeSniffer
+ */
+class PHP_CodeSniffer_DocGenerators_Markdown extends PHP_CodeSniffer_DocGenerators_Generator
+{
+
+
+    /**
+     * Generates the documentation for a standard.
+     *
+     * @return void
+     * @see    processSniff()
+     */
+    public function generate()
+    {
+        ob_start();
+        $this->printHeader();
+
+        $standardFiles = $this->getStandardFiles();
+
+        foreach ($standardFiles as $standard) {
+            $doc = new DOMDocument();
+            $doc->load($standard);
+            $documentation = $doc->getElementsByTagName('documentation')->item(0);
+            $this->processSniff($documentation);
+        }
+
+        $this->printFooter();
+        $content = ob_get_contents();
+        ob_end_clean();
+
+        echo $content;
+
+    }//end generate()
+
+
+    /**
+     * Print the markdown header.
+     *
+     * @return void
+     */
+    protected function printHeader()
+    {
+        $standard = $this->getStandard();
+
+        echo "# $standard Coding Standard".PHP_EOL;
+
+    }//end printHeader()
+
+
+    /**
+     * Print the markdown footer.
+     *
+     * @return void
+     */
+    protected function printFooter()
+    {
+        // Turn off errors so we don't get timezone warnings if people
+        // don't have their timezone set.
+        error_reporting(0);
+        echo 'Documentation generated on '.date('r');
+        echo ' by [PHP_CodeSniffer '.PHP_CodeSniffer::VERSION.'](https://github.com/squizlabs/PHP_CodeSniffer)';
+
+    }//end printFooter()
+
+
+    /**
+     * Process the documentation for a single sniff.
+     *
+     * @param DOMNode $doc The DOMNode object for the sniff.
+     *                     It represents the "documentation" tag in the XML
+     *                     standard file.
+     *
+     * @return void
+     */
+    protected function processSniff(DOMNode $doc)
+    {
+        $title = $this->getTitle($doc);
+        echo "## $title".PHP_EOL;
+
+        foreach ($doc->childNodes as $node) {
+            if ($node->nodeName === 'standard') {
+                $this->printTextBlock($node);
+            } else if ($node->nodeName === 'code_comparison') {
+                $this->printCodeComparisonBlock($node);
+            }
+        }
+
+    }//end processSniff()
+
+
+    /**
+     * Print a text block found in a standard.
+     *
+     * @param DOMNode $node The DOMNode object for the text block.
+     *
+     * @return void
+     */
+    protected function printTextBlock(DOMNode $node)
+    {
+        $content = trim($node->nodeValue);
+        $content = htmlspecialchars($content);
+
+        $content = str_replace('&lt;em&gt;', '*', $content);
+        $content = str_replace('&lt;/em&gt;', '*', $content);
+
+        echo $content.PHP_EOL;
+
+    }//end printTextBlock()
+
+
+    /**
+     * Print a code comparison block found in a standard.
+     *
+     * @param DOMNode $node The DOMNode object for the code comparison block.
+     *
+     * @return void
+     */
+    protected function printCodeComparisonBlock(DOMNode $node)
+    {
+        $codeBlocks = $node->getElementsByTagName('code');
+
+        $firstTitle = $codeBlocks->item(0)->getAttribute('title');
+        $first      = trim($codeBlocks->item(0)->nodeValue);
+        $first      = str_replace("\n", "\n    ", $first);
+        $first      = str_replace('<em>', '', $first);
+        $first      = str_replace('</em>', '', $first);
+
+        $secondTitle = $codeBlocks->item(1)->getAttribute('title');
+        $second      = trim($codeBlocks->item(1)->nodeValue);
+        $second      = str_replace("\n", "\n    ", $second);
+        $second      = str_replace('<em>', '', $second);
+        $second      = str_replace('</em>', '', $second);
+
+        echo '  <table>'.PHP_EOL;
+        echo '   <tr>'.PHP_EOL;
+        echo "    <th>$firstTitle</th>".PHP_EOL;
+        echo "    <th>$secondTitle</th>".PHP_EOL;
+        echo '   </tr>'.PHP_EOL;
+        echo '   <tr>'.PHP_EOL;
+        echo '<td>'.PHP_EOL.PHP_EOL;
+        echo "    $first".PHP_EOL.PHP_EOL;
+        echo '</td>'.PHP_EOL;
+        echo '<td>'.PHP_EOL.PHP_EOL;
+        echo "    $second".PHP_EOL.PHP_EOL;
+        echo '</td>'.PHP_EOL;
+        echo '   </tr>'.PHP_EOL;
+        echo '  </table>'.PHP_EOL;
+
+    }//end printCodeComparisonBlock()
+
+
+}//end class