7918681270

Committed 15 Feb 2024 03:56PM UTC coverage: 74.196%. Remained the same

Build # 7918681270

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #340 from fredden/missing-fixed-file/Squiz.Commenting.ClosingDeclarationComment

`Squiz.Commenting.ClosingDeclarationComment` - add missing `.fixed` file for test-suite, and fix a bug found during

Run Details

22531 of 30367 relevant lines covered (74.2%)

48.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/Generators/HTML.php

<?php
/**
 * A doc generator that outputs documentation in one big HTML file.
 *
 * Output is in one large HTML file and is designed for you to style with
 * your own stylesheet. It contains a table of contents at the top with anchors
 * to each sniff.
 *
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 */

namespace PHP_CodeSniffer\Generators;

use PHP_CodeSniffer\Config;

class HTML extends Generator
{


    /**
     * Generates the documentation for a standard.
     *
     * @return void
     * @see    processSniff()
     */
    public function generate()
    {
        ob_start();
        $this->printHeader();
        $this->printToc();

        foreach ($this->docFiles as $file) {
            $doc = new \DOMDocument();
            $doc->load($file);
            $documentation = $doc->getElementsByTagName('documentation')->item(0);
            $this->processSniff($documentation);
        }

        $this->printFooter();

        $content = ob_get_contents();
        ob_end_clean();

        echo $content;

    }//end generate()


    /**
     * Print the header of the HTML page.
     *
     * @return void
     */
    protected function printHeader()
    {
        $standard = $this->ruleset->name;
        echo '<html>'.PHP_EOL;
        echo ' <head>'.PHP_EOL;
        echo "  <title>$standard Coding Standards</title>".PHP_EOL;
        echo '  <style>
                    body {
                        background-color: #FFFFFF;
                        font-size: 14px;
                        font-family: Arial, Helvetica, sans-serif;
                        color: #000000;
                    }

                    h1 {
                        color: #666666;
                        font-size: 20px;
                        font-weight: bold;
                        margin-top: 0px;
                        background-color: #E6E7E8;
                        padding: 20px;
                        border: 1px solid #BBBBBB;
                    }

                    h2 {
                        color: #00A5E3;
                        font-size: 16px;
                        font-weight: normal;
                        margin-top: 50px;
                    }

                    .code-comparison {
                        width: 100%;
                    }

                    .code-comparison td {
                        border: 1px solid #CCCCCC;
                    }

                    .code-comparison-title, .code-comparison-code {
                        font-family: Arial, Helvetica, sans-serif;
                        font-size: 12px;
                        color: #000000;
                        vertical-align: top;
                        padding: 4px;
                        width: 50%;
                        background-color: #F1F1F1;
                        line-height: 15px;
                    }

                    .code-comparison-code {
                        font-family: Courier;
                        background-color: #F9F9F9;
                    }

                    .code-comparison-highlight {
                        background-color: #DDF1F7;
                        border: 1px solid #00A5E3;
                        line-height: 15px;
                    }

                    .tag-line {
                        text-align: center;
                        width: 100%;
                        margin-top: 30px;
                        font-size: 12px;
                    }

                    .tag-line a {
                        color: #000000;
                    }
                </style>'.PHP_EOL;
        echo ' </head>'.PHP_EOL;
        echo ' <body>'.PHP_EOL;
        echo "  <h1>$standard Coding Standards</h1>".PHP_EOL;

    }//end printHeader()


    /**
     * Print the table of contents for the standard.
     *
     * The TOC is just an unordered list of bookmarks to sniffs on the page.
     *
     * @return void
     */
    protected function printToc()
    {
        echo '  <h2>Table of Contents</h2>'.PHP_EOL;
        echo '  <ul class="toc">'.PHP_EOL;

        foreach ($this->docFiles as $file) {
            $doc = new \DOMDocument();
            $doc->load($file);
            $documentation = $doc->getElementsByTagName('documentation')->item(0);
            $title         = $this->getTitle($documentation);
            echo '   <li><a href="#'.str_replace(' ', '-', $title)."\">$title</a></li>".PHP_EOL;
        }

        echo '  </ul>'.PHP_EOL;

    }//end printToc()


    /**
     * Print the footer of the HTML page.
     *
     * @return void
     */
    protected function printFooter()
    {
        // Turn off errors so we don't get timezone warnings if people
        // don't have their timezone set.
        $errorLevel = error_reporting(0);
        echo '  <div class="tag-line">';
        echo 'Documentation generated on '.date('r');
        echo ' by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer '.Config::VERSION.'</a>';
        echo '</div>'.PHP_EOL;
        error_reporting($errorLevel);

        echo ' </body>'.PHP_EOL;
        echo '</html>'.PHP_EOL;

    }//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
     */
    public function processSniff(\DOMNode $doc)
    {
        $title = $this->getTitle($doc);
        echo '  <a name="'.str_replace(' ', '-', $title).'" />'.PHP_EOL;
        echo "  <h2>$title</h2>".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);

        // Allow em tags only.
        $content = str_replace('&lt;em&gt;', '<em>', $content);
        $content = str_replace('&lt;/em&gt;', '</em>', $content);

        echo "  <p class=\"text\">$content</p>".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('<?php', '&lt;?php', $first);
        $first      = str_replace("\n", '</br>', $first);
        $first      = str_replace(' ', '&nbsp;', $first);
        $first      = str_replace('<em>', '<span class="code-comparison-highlight">', $first);
        $first      = str_replace('</em>', '</span>', $first);

        $secondTitle = $codeBlocks->item(1)->getAttribute('title');
        $second      = trim($codeBlocks->item(1)->nodeValue);
        $second      = str_replace('<?php', '&lt;?php', $second);
        $second      = str_replace("\n", '</br>', $second);
        $second      = str_replace(' ', '&nbsp;', $second);
        $second      = str_replace('<em>', '<span class="code-comparison-highlight">', $second);
        $second      = str_replace('</em>', '</span>', $second);

        echo '  <table class="code-comparison">'.PHP_EOL;
        echo '   <tr>'.PHP_EOL;
        echo "    <td class=\"code-comparison-title\">$firstTitle</td>".PHP_EOL;
        echo "    <td class=\"code-comparison-title\">$secondTitle</td>".PHP_EOL;
        echo '   </tr>'.PHP_EOL;
        echo '   <tr>'.PHP_EOL;
        echo "    <td class=\"code-comparison-code\">$first</td>".PHP_EOL;
        echo "    <td class=\"code-comparison-code\">$second</td>".PHP_EOL;
        echo '   </tr>'.PHP_EOL;
        echo '  </table>'.PHP_EOL;

    }//end printCodeComparisonBlock()


}//end class

1	<?php
2	/**
3	* A doc generator that outputs documentation in one big HTML file.
4	*
5	* Output is in one large HTML file and is designed for you to style with
6	* your own stylesheet. It contains a table of contents at the top with anchors
7	* to each sniff.
8	*
9	* @author Greg Sherwood <gsherwood@squiz.net>
10	* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
11	* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
12	*/
13
14	namespace PHP_CodeSniffer\Generators;
15
16	use PHP_CodeSniffer\Config;
17
18	class HTML extends Generator
19	{
20
21
22	/**
23	* Generates the documentation for a standard.
24	*
25	* @return void
26	* @see processSniff()
27	*/
28	public function generate()	×
29	{
30	ob_start();	×
31	$this->printHeader();	×
32	$this->printToc();	×
33
34	foreach ($this->docFiles as $file) {	×
35	$doc = new \DOMDocument();	×
36	$doc->load($file);	×
37	$documentation = $doc->getElementsByTagName('documentation')->item(0);	×
38	$this->processSniff($documentation);	×
39	}
40
41	$this->printFooter();	×
42
43	$content = ob_get_contents();	×
44	ob_end_clean();	×
45
46	echo $content;	×
47
48	}//end generate()
49
50
51	/**
52	* Print the header of the HTML page.
53	*
54	* @return void
55	*/
56	protected function printHeader()	×
57	{
58	$standard = $this->ruleset->name;	×
59	echo '<html>'.PHP_EOL;	×
60	echo ' <head>'.PHP_EOL;	×
61	echo " <title>$standard Coding Standards</title>".PHP_EOL;	×
62	echo ' <style>	×
63	body {
64	background-color: #FFFFFF;
65	font-size: 14px;
66	font-family: Arial, Helvetica, sans-serif;
67	color: #000000;
68	}
69
70	h1 {
71	color: #666666;
72	font-size: 20px;
73	font-weight: bold;
74	margin-top: 0px;
75	background-color: #E6E7E8;
76	padding: 20px;
77	border: 1px solid #BBBBBB;
78	}
79
80	h2 {
81	color: #00A5E3;
82	font-size: 16px;
83	font-weight: normal;
84	margin-top: 50px;
85	}
86
87	.code-comparison {
88	width: 100%;
89	}
90
91	.code-comparison td {
92	border: 1px solid #CCCCCC;
93	}
94
95	.code-comparison-title, .code-comparison-code {
96	font-family: Arial, Helvetica, sans-serif;
97	font-size: 12px;
98	color: #000000;
99	vertical-align: top;
100	padding: 4px;
101	width: 50%;
102	background-color: #F1F1F1;
103	line-height: 15px;
104	}
105
106	.code-comparison-code {
107	font-family: Courier;
108	background-color: #F9F9F9;
109	}
110
111	.code-comparison-highlight {
112	background-color: #DDF1F7;
113	border: 1px solid #00A5E3;
114	line-height: 15px;
115	}
116
117	.tag-line {
118	text-align: center;
119	width: 100%;
120	margin-top: 30px;
121	font-size: 12px;
122	}
123
124	.tag-line a {
125	color: #000000;
126	}
127	</style>'.PHP_EOL;	×
128	echo ' </head>'.PHP_EOL;	×
129	echo ' <body>'.PHP_EOL;	×
130	echo " <h1>$standard Coding Standards</h1>".PHP_EOL;	×
131
132	}//end printHeader()
133
134
135	/**
136	* Print the table of contents for the standard.
137	*
138	* The TOC is just an unordered list of bookmarks to sniffs on the page.
139	*
140	* @return void
141	*/
142	protected function printToc()	×
143	{
144	echo ' <h2>Table of Contents</h2>'.PHP_EOL;	×
145	echo ' <ul class="toc">'.PHP_EOL;	×
146
147	foreach ($this->docFiles as $file) {	×
148	$doc = new \DOMDocument();	×
149	$doc->load($file);	×
150	$documentation = $doc->getElementsByTagName('documentation')->item(0);	×
151	$title = $this->getTitle($documentation);	×
152	echo ' <li><a href="#'.str_replace(' ', '-', $title)."\">$title</a></li>".PHP_EOL;	×
153	}
154
155	echo ' </ul>'.PHP_EOL;	×
156
157	}//end printToc()
158
159
160	/**
161	* Print the footer of the HTML page.
162	*
163	* @return void
164	*/
165	protected function printFooter()	×
166	{
167	// Turn off errors so we don't get timezone warnings if people
168	// don't have their timezone set.
169	$errorLevel = error_reporting(0);	×
170	echo ' <div class="tag-line">';	×
171	echo 'Documentation generated on '.date('r');	×
172	echo ' by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer '.Config::VERSION.'</a>';	×
173	echo '</div>'.PHP_EOL;	×
174	error_reporting($errorLevel);	×
175
176	echo ' </body>'.PHP_EOL;	×
177	echo '</html>'.PHP_EOL;	×
178
179	}//end printFooter()
180
181
182	/**
183	* Process the documentation for a single sniff.
184	*
185	* @param \DOMNode $doc The DOMNode object for the sniff.
186	* It represents the "documentation" tag in the XML
187	* standard file.
188	*
189	* @return void
190	*/
191	public function processSniff(\DOMNode $doc)	×
192	{
193	$title = $this->getTitle($doc);	×
194	echo ' <a name="'.str_replace(' ', '-', $title).'" />'.PHP_EOL;	×
195	echo " <h2>$title</h2>".PHP_EOL;	×
196
197	foreach ($doc->childNodes as $node) {	×
198	if ($node->nodeName === 'standard') {	×
199	$this->printTextBlock($node);	×
200	} else if ($node->nodeName === 'code_comparison') {	×
201	$this->printCodeComparisonBlock($node);	×
202	}
203	}
204
205	}//end processSniff()
206
207
208	/**
209	* Print a text block found in a standard.
210	*
211	* @param \DOMNode $node The DOMNode object for the text block.
212	*
213	* @return void
214	*/
215	protected function printTextBlock(\DOMNode $node)	×
216	{
217	$content = trim($node->nodeValue);	×
218	$content = htmlspecialchars($content);	×
219
220	// Allow em tags only.
221	$content = str_replace('<em>', '<em>', $content);	×
222	$content = str_replace('</em>', '</em>', $content);	×
223
224	echo " <p class=\"text\">$content</p>".PHP_EOL;	×
225
226	}//end printTextBlock()
227
228
229	/**
230	* Print a code comparison block found in a standard.
231	*
232	* @param \DOMNode $node The DOMNode object for the code comparison block.
233	*
234	* @return void
235	*/
236	protected function printCodeComparisonBlock(\DOMNode $node)	×
237	{
238	$codeBlocks = $node->getElementsByTagName('code');	×
239
240	$firstTitle = $codeBlocks->item(0)->getAttribute('title');	×
241	$first = trim($codeBlocks->item(0)->nodeValue);	×
242	$first = str_replace('<?php', '<?php', $first);	×
243	$first = str_replace("\n", '</br>', $first);	×
244	$first = str_replace(' ', ' ', $first);	×
245	$first = str_replace('<em>', '<span class="code-comparison-highlight">', $first);	×
246	$first = str_replace('</em>', '</span>', $first);	×
247
248	$secondTitle = $codeBlocks->item(1)->getAttribute('title');	×
249	$second = trim($codeBlocks->item(1)->nodeValue);	×
250	$second = str_replace('<?php', '<?php', $second);	×
251	$second = str_replace("\n", '</br>', $second);	×
252	$second = str_replace(' ', ' ', $second);	×
253	$second = str_replace('<em>', '<span class="code-comparison-highlight">', $second);	×
254	$second = str_replace('</em>', '</span>', $second);	×
255
256	echo ' <table class="code-comparison">'.PHP_EOL;	×
257	echo ' <tr>'.PHP_EOL;	×
258	echo " <td class=\"code-comparison-title\">$firstTitle</td>".PHP_EOL;	×
259	echo " <td class=\"code-comparison-title\">$secondTitle</td>".PHP_EOL;	×
260	echo ' </tr>'.PHP_EOL;	×
261	echo ' <tr>'.PHP_EOL;	×
262	echo " <td class=\"code-comparison-code\">$first</td>".PHP_EOL;	×
263	echo " <td class=\"code-comparison-code\">$second</td>".PHP_EOL;	×
264	echo ' </tr>'.PHP_EOL;	×
265	echo ' </table>'.PHP_EOL;	×
266
267	}//end printCodeComparisonBlock()
268
269
270	}//end class

PHPCSStandards / PHP_CodeSniffer / 7918681270

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous