class Drupal_Sniffs_Semantics_LStringTranslatableSniff in Coder 7.2
Checks that string literals passed to l() are translatable.
@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer
Hierarchy
- class \Drupal_Sniffs_Semantics_FunctionCall implements \PHP_CodeSniffer_Sniff
Expanded class hierarchy of Drupal_Sniffs_Semantics_LStringTranslatableSniff
File
- coder_sniffer/
Drupal/ Sniffs/ Semantics/ LStringTranslatableSniff.php, line 19
View source
class Drupal_Sniffs_Semantics_LStringTranslatableSniff extends Drupal_Sniffs_Semantics_FunctionCall {
/**
* Returns an array of function names this test wants to listen for.
*
* @return array
*/
public function registerFunctionNames() {
return array(
'l',
);
}
//end registerFunctionNames()
/**
* Processes this function call.
*
* @param PHP_CodeSniffer_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.
* @param Drupal_Sniffs_Semantics_FunctionCallSniff $sniff
* Can be used to retreive the function's arguments with the getArgument()
* method.
*
* @return void
*/
public function processFunctionCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $closeBracket, Drupal_Sniffs_Semantics_FunctionCallSniff $sniff) {
$tokens = $phpcsFile
->getTokens();
// Get the first argument passed to l().
$argument = $sniff
->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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Drupal_Sniffs_Semantics_FunctionCall:: |
public | function | Processes this test, when one of its tokens is encountered. | |
Drupal_Sniffs_Semantics_FunctionCall:: |
public | function | Returns an array of tokens this test wants to listen for. | |
Drupal_Sniffs_Semantics_LStringTranslatableSniff:: |
public | function |
Processes this function call. Overrides Drupal_Sniffs_Semantics_FunctionCall:: |
|
Drupal_Sniffs_Semantics_LStringTranslatableSniff:: |
public | function | Returns an array of function names this test wants to listen for. |