-
Notifications
You must be signed in to change notification settings - Fork 159
/
Copy pathEmailTemplateSniff.php
55 lines (50 loc) · 1.34 KB
/
EmailTemplateSniff.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<?php
/**
* Copyright 2021 Adobe
* All Rights Reserved.
*/
declare(strict_types=1);
namespace Magento2\Sniffs\Legacy;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
/**
* Test for obsolete email directives in view/email/*.html
*/
class EmailTemplateSniff implements Sniff
{
private const OBSOLETE_EMAIL_DIRECTIVES = [
'FoundObsoleteHtmlescapeDirective' => [
'pattern' => '/\{\{htmlescape.*?\}\}/i',
'message' => 'Directive {{htmlescape}} is obsolete. Use {{var}} instead.',
],
'FoundObsoleteEscapehtmlDirective' => [
'pattern' => '/\{\{escapehtml.*?\}\}/i',
'message' => 'Directive {{escapehtml}} is obsolete. Use {{var}} instead.',
],
];
/**
* @inheritdoc
*/
public function register(): array
{
return [
T_INLINE_HTML
];
}
/**
* @inheritDoc
*/
public function process(File $phpcsFile, $stackPtr)
{
$content = $phpcsFile->getTokens()[$stackPtr]['content'];
foreach (self::OBSOLETE_EMAIL_DIRECTIVES as $code => $data) {
if (preg_match($data['pattern'], $content)) {
$phpcsFile->addError(
$data['message'],
$stackPtr,
$code
);
}
}
}
}