You are here

class LStringTranslatableSniff in Coder 8.3

Same name and namespace in other branches
  1. 8.2 coder_sniffer/Drupal/Sniffs/Semantics/LStringTranslatableSniff.php \Drupal\Sniffs\Semantics\LStringTranslatableSniff
  2. 8.3.x coder_sniffer/Drupal/Sniffs/Semantics/LStringTranslatableSniff.php \Drupal\Sniffs\Semantics\LStringTranslatableSniff

Checks that string literals passed to l() are translatable.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

Expanded class hierarchy of LStringTranslatableSniff

File

coder_sniffer/Drupal/Sniffs/Semantics/LStringTranslatableSniff.php, line 21

Namespace

Drupal\Sniffs\Semantics
View source
class LStringTranslatableSniff extends FunctionCall {

  /**
   * Returns an array of function names this test wants to listen for.
   *
   * @return array<string>
   */
  public function registerFunctionNames() {
    return [
      'l',
    ];
  }

  //end registerFunctionNames()

  /**
   * Processes this function call.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile    The file being scanned.
   * @param int                         $stackPtr     The position of the function call in
   *                                                  the stack.
   * @param int                         $openBracket  The position of the opening
   *                                                  parenthesis in the stack.
   * @param int                         $closeBracket The position of the closing
   *                                                  parenthesis in the stack.
   *
   * @return void
   */
  public function processFunctionCall(File $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
    $tokens = $phpcsFile
      ->getTokens();

    // Get the first argument passed to l().
    $argument = $this
      ->getArgument(1);
    if ($tokens[$argument['start']]['code'] === T_CONSTANT_ENCAPSED_STRING && $tokens[$argument['start']]['content'][1] !== '<') {
      $error = 'The $text argument to l() should be enclosed within t() so that it is translatable';
      $phpcsFile
        ->addError($error, $stackPtr, 'LArg');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FunctionCall::$arguments protected property Internal cache to save the calculated arguments of the function call.
FunctionCall::$closeBracket protected property The token position of the closing bracket of the function call.
FunctionCall::$functionCall protected property The token position of the function call.
FunctionCall::$includeMethodCalls protected property Whether method invocations with the same function name should be processed, too. 1
FunctionCall::$openBracket protected property The token position of the opening bracket of the function call.
FunctionCall::$phpcsFile protected property The currently processed file.
FunctionCall::getArgument public function Returns start and end token for a given argument number.
FunctionCall::isFunctionCall protected function Checks if this is a function call.
FunctionCall::process public function Processes this test, when one of its tokens is encountered. 2
FunctionCall::register public function Returns an array of tokens this test wants to listen for.
LStringTranslatableSniff::processFunctionCall public function Processes this function call.
LStringTranslatableSniff::registerFunctionNames public function Returns an array of function names this test wants to listen for.