class DocCommentUnitTest in Coder 8.3.x

Hierarchy

• class \Drupal\Test\CoderSniffUnitTest extends \Drupal\Test\PhpunitCompatibilityTestCase
  • class \Drupal\Test\Commenting\DocCommentUnitTest

File

tests/Drupal/Commenting/DocCommentUnitTest.php, line 7

Namespace

Drupal\Test\Commenting

class DocCommentUnitTest extends CoderSniffUnitTest {

  /**
   * Returns the lines where errors should occur.
   *
   * The key of the array should represent the line number and the value
   * should represent the number of errors that should occur on that line.
   *
   * @param string $testFile The name of the file being tested.
   *
   * @return array<int, int>
   */
  protected function getErrorList(string $testFile) : array {
    switch ($testFile) {
      case 'DocCommentUnitTest.inc':
        return [
          8 => 1,
          12 => 1,
          14 => 1,
          16 => 1,
          29 => 1,
          36 => 2,
          45 => 1,
          66 => 1,
          100 => 4,
          101 => 1,
        ];
      case 'DocCommentUnitTest.1.inc':
        return [
          24 => 1,
          28 => 1,
          32 => 1,
          36 => 1,
          41 => 2,
        ];
      case 'DocCommentUnitTest.3.inc':
        return [
          4 => 1,
        ];
      default:
        return [];
    }

    //end switch
  }

  //end getErrorList()

  /**
   * Returns the lines where warnings should occur.
   *
   * The key of the array should represent the line number and the value
   * should represent the number of warnings that should occur on that line.
   *
   * @param string $testFile The name of the file being tested.
   *
   * @return array<int, int>
   */
  protected function getWarningList(string $testFile) : array {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CoderSniffUnitTest::$backupGlobals	protected	property	Enable or disable the backup and restoration of the $GLOBALS array. Overwrite this attribute in a child class of TestCase. Setting this attribute in setUp() has no effect!
CoderSniffUnitTest::$rootDir	private	property	The path to the root folder of Coder.
CoderSniffUnitTest::$standardsDir	public	property	The path to the standard's main directory.
CoderSniffUnitTest::$testsDir	public	property	The path to the standard's test directory.
CoderSniffUnitTest::checkAllSniffCodes	protected	function	False if just the current sniff should be checked, true if all sniffs should be checked.	3
CoderSniffUnitTest::compatibleSetUp	protected	function	Sets up this unit test.
CoderSniffUnitTest::generateFailureMessages	public	function	Generate a list of test failures for a given sniffed file.
CoderSniffUnitTest::getTestFiles	protected	function	Get a list of all test files to check.	20
CoderSniffUnitTest::setCliValues	public	function	Set a list of CLI values before the file is tested.
CoderSniffUnitTest::shouldSkipTest	protected	function	Should this test be skipped for some reason.
CoderSniffUnitTest::testSniff	final public	function	Tests the extending classes Sniff class.
DocCommentUnitTest::getErrorList	protected	function	Returns the lines where errors should occur. Overrides CoderSniffUnitTest::getErrorList
DocCommentUnitTest::getWarningList	protected	function	Returns the lines where warnings should occur. Overrides CoderSniffUnitTest::getWarningList