Skip to content

Commit 6afec51

Browse files
jrfnljrfnl
authored
Merge pull request #854 from PHPCSStandards/feature/generators-html-improve-semantics
Generators/HTML: improve code table semantics
2 parents 9c6ad66 + b765b12 commit 6afec51

29 files changed

+199
-54
lines changed

‎src/Generators/HTML.php

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,11 @@ class HTML extends Generator
7272
line-height: 15px;
7373
}
7474
75+
.code-comparison-title {
76+
text-align: left;
77+
font-weight: 600;
78+
}
79+
7580
.code-comparison-code {
7681
font-family: Courier;
7782
background-color: #F9F9F9;
@@ -410,8 +415,8 @@ protected function getFormattedCodeComparisonBlock(DOMNode $node)
410415
$titleRow = '';
411416
if ($firstTitle !== '' || $secondTitle !== '') {
412417
$titleRow .= ' <tr>'.PHP_EOL;
413-
$titleRow .= " <td class=\"code-comparison-title\">$firstTitle</td>".PHP_EOL;
414-
$titleRow .= " <td class=\"code-comparison-title\">$secondTitle</td>".PHP_EOL;
418+
$titleRow .= " <th class=\"code-comparison-title\">$firstTitle</th>".PHP_EOL;
419+
$titleRow .= " <th class=\"code-comparison-title\">$secondTitle</th>".PHP_EOL;
415420
$titleRow .= ' </tr>'.PHP_EOL;
416421
}
417422

‎tests/Core/Generators/Expectations/ExpectedOutputCodeComparisonBlankLines.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -75,8 +80,8 @@ <h2>Code Comparison, blank lines</h2>
7580
<p class="text">This is a standard block.</p>
7681
<table class="code-comparison">
7782
<tr>
78-
<td class="code-comparison-title">Valid: Checking handling of blank lines.</td>
79-
<td class="code-comparison-title">Invalid: Checking handling of blank lines.</td>
83+
<th class="code-comparison-title">Valid: Checking handling of blank lines.</th>
84+
<th class="code-comparison-title">Invalid: Checking handling of blank lines.</th>
8085
</tr>
8186
<tr>
8287
<td class="code-comparison-code">//&nbsp;First&nbsp;line&nbsp;of&nbsp;the&nbsp;code&nbsp;sample&nbsp;is</br>//&nbsp;deliberately&nbsp;empty.</br></br>//&nbsp;We&nbsp;also&nbsp;have&nbsp;a&nbsp;blank&nbsp;line&nbsp;in&nbsp;the&nbsp;middle.</br></br>//&nbsp;And&nbsp;a&nbsp;blank&nbsp;line&nbsp;at&nbsp;the&nbsp;end.</td>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeComparisonBlockLength.html

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -75,8 +80,8 @@ <h2>Code Comparison, block length</h2>
7580
<p class="text">This is a standard block.</p>
7681
<table class="code-comparison">
7782
<tr>
78-
<td class="code-comparison-title">Valid: code sample A has more lines than B.</td>
79-
<td class="code-comparison-title">Invalid: shorter.</td>
83+
<th class="code-comparison-title">Valid: code sample A has more lines than B.</th>
84+
<th class="code-comparison-title">Invalid: shorter.</th>
8085
</tr>
8186
<tr>
8287
<td class="code-comparison-code">//&nbsp;This&nbsp;code&nbsp;sample&nbsp;has&nbsp;more&nbsp;lines</br>//&nbsp;than&nbsp;the&nbsp;"invalid"&nbsp;one.</br><span class="code-comparison-highlight">$one</span>&nbsp;=&nbsp;10;</td>
@@ -85,8 +90,8 @@ <h2>Code Comparison, block length</h2>
8590
</table>
8691
<table class="code-comparison">
8792
<tr>
88-
<td class="code-comparison-title">Valid: shorter.</td>
89-
<td class="code-comparison-title">Invalid: code sample B has more lines than A.</td>
93+
<th class="code-comparison-title">Valid: shorter.</th>
94+
<th class="code-comparison-title">Invalid: code sample B has more lines than A.</th>
9095
</tr>
9196
<tr>
9297
<td class="code-comparison-code"><span class="code-comparison-highlight">echo</span>&nbsp;$foo;</td>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeComparisonEncoding.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -75,8 +80,8 @@ <h2>Code Comparison, char encoding</h2>
7580
<p class="text">This is a standard block.</p>
7681
<table class="code-comparison">
7782
<tr>
78-
<td class="code-comparison-title">Valid: Vestibulum et orci condimentum.</td>
79-
<td class="code-comparison-title">Invalid: Donec in nisl ut tortor convallis interdum.</td>
83+
<th class="code-comparison-title">Valid: Vestibulum et orci condimentum.</th>
84+
<th class="code-comparison-title">Invalid: Donec in nisl ut tortor convallis interdum.</th>
8085
</tr>
8186
<tr>
8287
<td class="code-comparison-code">&lt;?php</br></br>//&nbsp;The&nbsp;above&nbsp;PHP&nbsp;tag&nbsp;is&nbsp;specifically&nbsp;testing</br>//&nbsp;handling&nbsp;of&nbsp;that&nbsp;in&nbsp;generated&nbsp;HTML&nbsp;doc.</br></br>//&nbsp;Now&nbsp;let's&nbsp;also&nbsp;check&nbsp;the&nbsp;handling&nbsp;of</br>//&nbsp;comparison&nbsp;operators&nbsp;in&nbsp;code&nbsp;samples...</br>$a&nbsp;=&nbsp;$b&nbsp;<&nbsp;$c;</br>$d&nbsp;=&nbsp;$e&nbsp;>&nbsp;$f;</br>$g&nbsp;=&nbsp;$h&nbsp;<=&nbsp;$i;</br>$j&nbsp;=&nbsp;$k&nbsp;>=&nbsp;$l;</br>$m&nbsp;=&nbsp;$n&nbsp;<=>&nbsp;$o;</td>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeComparisonLineLength.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -76,8 +81,8 @@ <h2>Code Comparison, line length</h2>
7681
Ref: squizlabs/PHP_CodeSniffer#2522</p>
7782
<table class="code-comparison">
7883
<tr>
79-
<td class="code-comparison-title">Valid: contains line which is too long.</td>
80-
<td class="code-comparison-title">Invalid: contains line which is too long.</td>
84+
<th class="code-comparison-title">Valid: contains line which is too long.</th>
85+
<th class="code-comparison-title">Invalid: contains line which is too long.</th>
8186
</tr>
8287
<tr>
8388
<td class="code-comparison-code">class&nbsp;Foo&nbsp;extends&nbsp;Bar&nbsp;implements&nbsp;<span class="code-comparison-highlight">Countable</span>,&nbsp;Serializable</br>{</br>}</td>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeTitleLineWrapping.html

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -75,8 +80,8 @@ <h2>Code Title, line wrapping</h2>
7580
<p class="text">This is a standard block.</p>
7681
<table class="code-comparison">
7782
<tr>
78-
<td class="code-comparison-title">Valid: exactly 45 character long description.</td>
79-
<td class="code-comparison-title">Invalid: exactly 45 char long description---.</td>
83+
<th class="code-comparison-title">Valid: exactly 45 character long description.</th>
84+
<th class="code-comparison-title">Invalid: exactly 45 char long description---.</th>
8085
</tr>
8186
<tr>
8287
<td class="code-comparison-code">//&nbsp;Dummy.</td>
@@ -85,8 +90,8 @@ <h2>Code Title, line wrapping</h2>
8590
</table>
8691
<table class="code-comparison">
8792
<tr>
88-
<td class="code-comparison-title">Valid: exactly 46 character long description-.</td>
89-
<td class="code-comparison-title">Invalid: exactly 46 character long description</td>
93+
<th class="code-comparison-title">Valid: exactly 46 character long description-.</th>
94+
<th class="code-comparison-title">Invalid: exactly 46 character long description</th>
9095
</tr>
9196
<tr>
9297
<td class="code-comparison-code">//&nbsp;Dummy.</td>
@@ -95,8 +100,8 @@ <h2>Code Title, line wrapping</h2>
95100
</table>
96101
<table class="code-comparison">
97102
<tr>
98-
<td class="code-comparison-title">Valid: exactly 47 character long description--.</td>
99-
<td class="code-comparison-title">Invalid: exactly 47 character long description.</td>
103+
<th class="code-comparison-title">Valid: exactly 47 character long description--.</th>
104+
<th class="code-comparison-title">Invalid: exactly 47 character long description.</th>
100105
</tr>
101106
<tr>
102107
<td class="code-comparison-code">//&nbsp;Dummy.</td>
@@ -105,8 +110,8 @@ <h2>Code Title, line wrapping</h2>
105110
</table>
106111
<table class="code-comparison">
107112
<tr>
108-
<td class="code-comparison-title">Valid: this description is longer than 46 characters and will wrap.</td>
109-
<td class="code-comparison-title">Invalid: this description is longer than 46 characters and will wrap.</td>
113+
<th class="code-comparison-title">Valid: this description is longer than 46 characters and will wrap.</th>
114+
<th class="code-comparison-title">Invalid: this description is longer than 46 characters and will wrap.</th>
110115
</tr>
111116
<tr>
112117
<td class="code-comparison-code">//&nbsp;Dummy.</td>

‎tests/Core/Generators/Expectations/ExpectedOutputCodeTitleWhitespace.html

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -75,8 +80,8 @@ <h2>Code Title, whitespace handling</h2>
7580
<p class="text">This is a standard block.</p>
7681
<table class="code-comparison">
7782
<tr>
78-
<td class="code-comparison-title">Valid: spaces at start of description.</td>
79-
<td class="code-comparison-title">Invalid: spaces at end making line > 46 chars.</td>
83+
<th class="code-comparison-title">Valid: spaces at start of description.</th>
84+
<th class="code-comparison-title">Invalid: spaces at end making line > 46 chars.</th>
8085
</tr>
8186
<tr>
8287
<td class="code-comparison-code">//&nbsp;Dummy.</td>
@@ -85,8 +90,8 @@ <h2>Code Title, whitespace handling</h2>
8590
</table>
8691
<table class="code-comparison">
8792
<tr>
88-
<td class="code-comparison-title">Valid: spaces at start + end of description.</td>
89-
<td class="code-comparison-title">Invalid: spaces '&nbsp;&nbsp;&nbsp;&nbsp; ' in description.</td>
93+
<th class="code-comparison-title">Valid: spaces at start + end of description.</th>
94+
<th class="code-comparison-title">Invalid: spaces '&nbsp;&nbsp;&nbsp;&nbsp; ' in description.</th>
9095
</tr>
9196
<tr>
9297
<td class="code-comparison-code">//&nbsp;Note:&nbsp;description&nbsp;above&nbsp;without&nbsp;the</br>//&nbsp;trailing&nbsp;whitespace&nbsp;fits&nbsp;in&nbsp;46&nbsp;chars.</td>

‎tests/Core/Generators/Expectations/ExpectedOutputDocumentationTitleCase.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;

‎tests/Core/Generators/Expectations/ExpectedOutputDocumentationTitleLength.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;

‎tests/Core/Generators/Expectations/ExpectedOutputDocumentationTitlePCREFallback.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMismatchedCodeElms.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -75,8 +80,8 @@ <h2>Code Comparison, mismatched code blocks</h2>
7580
<p class="text">This doc has two code elements, one only has a title, one has actual code. Unbalanced</p>
7681
<table class="code-comparison">
7782
<tr>
78-
<td class="code-comparison-title">Code title</td>
79-
<td class="code-comparison-title"></td>
83+
<th class="code-comparison-title">Code title</th>
84+
<th class="code-comparison-title"></th>
8085
</tr>
8186
<tr>
8287
<td class="code-comparison-code"></td>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMissingCodeElm.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonNoCode.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -75,8 +80,8 @@ <h2>Code Comparison, no code</h2>
7580
<p class="text">This is a standard block.</p>
7681
<table class="code-comparison">
7782
<tr>
78-
<td class="code-comparison-title">Valid: no code.</td>
79-
<td class="code-comparison-title">Invalid: no code.</td>
83+
<th class="code-comparison-title">Valid: no code.</th>
84+
<th class="code-comparison-title">Invalid: no code.</th>
8085
</tr>
8186
</table>
8287
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonNoContent.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonOneEmptyCodeElm.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;
@@ -75,8 +80,8 @@ <h2>Code Comparison, one empty code element</h2>
7580
<p class="text">This doc has two code elements, but only one of them has a title and actual code.</p>
7681
<table class="code-comparison">
7782
<tr>
78-
<td class="code-comparison-title">Code title</td>
79-
<td class="code-comparison-title"></td>
83+
<th class="code-comparison-title">Code title</th>
84+
<th class="code-comparison-title"></th>
8085
</tr>
8186
<tr>
8287
<td class="code-comparison-code">$a&nbsp;=&nbsp;'Example&nbsp;code';</td>

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonTwoEmptyCodeElms.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeTitleEmpty.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;

‎tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeTitleMissing.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
line-height: 15px;
4646
}
4747

48+
.code-comparison-title {
49+
text-align: left;
50+
font-weight: 600;
51+
}
52+
4853
.code-comparison-code {
4954
font-family: Courier;
5055
background-color: #F9F9F9;

0 commit comments

Comments
 (0)