class ValidClassNameSniff in Coder 8.3.x

\Drupal\Sniffs\NamingConventions\ValidClassNameSniff.

Ensures class and interface names start with a capital letter and do not use _ separators.

@category PHP @package PHP_CodeSniffer @author Greg Sherwood <[e-mail]> @author Marc McIntyre <[e-mail]> @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600) @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence @version Release: 1.2.0RC3 @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

• class \Drupal\Sniffs\NamingConventions\ValidClassNameSniff implements \PHP_CodeSniffer\Sniffs\Sniff

File

coder_sniffer/Drupal/Sniffs/NamingConventions/ValidClassNameSniff.php, line 34

Namespace

Drupal\Sniffs\NamingConventions

class ValidClassNameSniff implements Sniff {

  /**
   * Returns an array of tokens this test wants to listen for.
   *
   * @return array<int|string>
   */
  public function register() {
    return [
      T_CLASS,
      T_INTERFACE,
    ];
  }

  //end register()

  /**
   * Processes this test, when one of its tokens is encountered.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being processed.
   * @param int                         $stackPtr  The position of the current token
   *                                               in the stack passed in $tokens.
   *
   * @return void
   */
  public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile
      ->getTokens();
    $className = $phpcsFile
      ->findNext(T_STRING, $stackPtr);
    $name = trim($tokens[$className]['content']);
    $errorData = [
      ucfirst($tokens[$stackPtr]['content']),
    ];

    // Make sure the first letter is a capital.
    if (preg_match('|^[A-Z]|', $name) === 0) {
      $error = '%s name must begin with a capital letter';
      $phpcsFile
        ->addError($error, $stackPtr, 'StartWithCaptial', $errorData);
    }

    // Search for underscores.
    if (strpos($name, '_') !== false) {
      $error = '%s name must use UpperCamel naming without underscores';
      $phpcsFile
        ->addError($error, $stackPtr, 'NoUnderscores', $errorData);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ValidClassNameSniff::process	public	function	Processes this test, when one of its tokens is encountered.
ValidClassNameSniff::register	public	function	Returns an array of tokens this test wants to listen for.