4.0 | Generators: add parameter types

Includes changing the expected parameter type for a couple of methods from `DomNode` to `DomElement`.
The previous was incorrect, but changing the method signature by making a type more specific, is a breaking change, so had to wait until now.

Author: jrfnl

src/Generators/Generator.php

@@ -75,15 +75,15 @@ public function __construct(Ruleset $ruleset)
 
 
     /**
-     * Retrieves the title of the sniff from the DOMNode supplied.
+     * Retrieves the title of the sniff from the DOMElement supplied.
      *
-     * @param \DOMNode $doc The DOMNode object for the sniff.
-     *                      It represents the "documentation" tag in the XML
-     *                      standard file.
+     * @param \DOMElement $doc The DOMElement object for the sniff.
+     *                         It represents the "documentation" tag in the XML
+     *                         standard file.
      *
      * @return string
      */
-    protected function getTitle(DOMNode $doc)
+    protected function getTitle(DOMElement $doc)
     {
         $title = $doc->getAttribute('title');
 
@@ -141,14 +141,14 @@ public function generate()
      *
      * Doc generators must implement this function to produce output.
      *
-     * @param \DOMNode $doc The DOMNode object for the sniff.
-     *                      It represents the "documentation" tag in the XML
-     *                      standard file.
+     * @param \DOMElement $doc The DOMElement object for the sniff.
+     *                         It represents the "documentation" tag in the XML
+     *                         standard file.
      *
      * @return void
      * @see    generate()
      */
-    abstract protected function processSniff(DOMNode $doc);
+    abstract protected function processSniff(DOMElement $doc);
 
 
 }//end class

src/Generators/HTML.php

@@ -262,13 +262,13 @@ protected function getFormattedFooter()
     /**
      * 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.
+     * @param \DOMElement $doc The DOMElement object for the sniff.
+     *                         It represents the "documentation" tag in the XML
+     *                         standard file.
      *
      * @return void
      */
-    public function processSniff(DOMNode $doc)
+    public function processSniff(DOMElement $doc)
     {
         $content = '';
         foreach ($doc->childNodes as $node) {
@@ -301,7 +301,7 @@ public function processSniff(DOMNode $doc)
      *
      * @return string
      */
-    private function titleToAnchor($title)
+    private function titleToAnchor(string $title)
     {
         // Slugify the text.
         $title = strtolower($title);

src/Generators/Markdown.php

@@ -100,13 +100,13 @@ protected function getFormattedFooter()
     /**
      * 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.
+     * @param \DOMElement $doc The DOMElement object for the sniff.
+     *                         It represents the "documentation" tag in the XML
+     *                         standard file.
      *
      * @return void
      */
-    protected function processSniff(DOMNode $doc)
+    protected function processSniff(DOMElement $doc)
     {
         $content = '';
         foreach ($doc->childNodes as $node) {

src/Generators/Text.php

@@ -23,13 +23,13 @@ class Text extends Generator
     /**
      * 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.
+     * @param \DOMElement $doc The DOMElement object for the sniff.
+     *                         It represents the "documentation" tag in the XML
+     *                         standard file.
      *
      * @return void
      */
-    public function processSniff(DOMNode $doc)
+    public function processSniff(DOMElement $doc)
     {
         $content = '';
         foreach ($doc->childNodes as $node) {
@@ -50,16 +50,16 @@ public function processSniff(DOMNode $doc)
     /**
      * Format the title area for a single sniff.
      *
-     * @param \DOMNode $doc The DOMNode object for the sniff.
-     *                      It represents the "documentation" tag in the XML
-     *                      standard file.
+     * @param \DOMElement $doc The DOMElement object for the sniff.
+     *                         It represents the "documentation" tag in the XML
+     *                         standard file.
      *
      * @since 3.12.0 Replaces the Text::printTitle() method,
      *               which was deprecated in 3.12.0 and removed in 4.0.0.
      *
      * @return string
      */
-    protected function getFormattedTitle(DOMNode $doc)
+    protected function getFormattedTitle(DOMElement $doc)
     {
         $title        = $this->getTitle($doc);
         $standard     = $this->ruleset->name;

tests/Core/Generators/Fixtures/MockGenerator.php

@@ -8,7 +8,7 @@
 
 namespace PHP_CodeSniffer\Tests\Core\Generators\Fixtures;
 
-use DOMNode;
+use DOMElement;
 use PHP_CodeSniffer\Generators\Generator;
 
 class MockGenerator extends Generator
@@ -17,11 +17,11 @@ class MockGenerator extends Generator
     /**
      * Process the documentation for a single sniff.
      *
-     * @param \DOMNode $doc The DOMNode object for the sniff.
+     * @param \DOMElement $doc The DOMElement object for the sniff.
      *
      * @return void
      */
-    protected function processSniff(DOMNode $doc)
+    protected function processSniff(DOMElement $doc)
     {
         echo $this->getTitle($doc), PHP_EOL;
     }