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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<?php
/**
* Tests that embedded variables and expressions in heredoc strings are tokenized
* as one heredoc string token.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2022 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP;
use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase;
final class HeredocStringTest extends AbstractTokenizerTestCase
{
/**
* Test that heredoc strings contain the complete interpolated string.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $expectedContent The expected content of the heredoc string.
*
* @dataProvider dataHeredocString
* @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize
*
* @return void
*/
public function testHeredocString($testMarker, $expectedContent)
{
$tokens = $this->phpcsFile->getTokens();
$target = $this->getTargetToken($testMarker, T_HEREDOC);
$this->assertSame($expectedContent."\n", $tokens[$target]['content']);
}//end testHeredocString()
/**
* Test that heredoc strings contain the complete interpolated string when combined with other texts.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $expectedContent The expected content of the heredoc string.
*
* @dataProvider dataHeredocString
* @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize
*
* @return void
*/
public function testHeredocStringWrapped($testMarker, $expectedContent)
{
$tokens = $this->phpcsFile->getTokens();
$testMarker = substr($testMarker, 0, -3).'Wrapped */';
$target = $this->getTargetToken($testMarker, T_HEREDOC);
$this->assertSame('Do '.$expectedContent." Something\n", $tokens[$target]['content']);
}//end testHeredocStringWrapped()
/**
* Data provider.
*
* Type reference:
* 1. Directly embedded variables.
* 2. Braces outside the variable.
* 3. Braces after the dollar sign.
* 4. Variable variables and expressions.
*
* @link https://wiki.php.net/rfc/deprecate_dollar_brace_string_interpolation
*
* @see testHeredocString()
*
* @return array<string, array<string, string>>
*/
public static function dataHeredocString()
{
return [
'Type 1: simple variable' => [
'testMarker' => '/* testSimple1 */',
'expectedContent' => '$foo',
],
'Type 2: simple variable' => [
'testMarker' => '/* testSimple2 */',
'expectedContent' => '{$foo}',
],
'Type 3: simple variable' => [
'testMarker' => '/* testSimple3 */',
'expectedContent' => '${foo}',
],
'Type 1: array offset' => [
'testMarker' => '/* testDIM1 */',
'expectedContent' => '$foo[bar]',
],
'Type 2: array offset' => [
'testMarker' => '/* testDIM2 */',
'expectedContent' => '{$foo[\'bar\']}',
],
'Type 3: array offset' => [
'testMarker' => '/* testDIM3 */',
'expectedContent' => '${foo[\'bar\']}',
],
'Type 1: object property' => [
'testMarker' => '/* testProperty1 */',
'expectedContent' => '$foo->bar',
],
'Type 2: object property' => [
'testMarker' => '/* testProperty2 */',
'expectedContent' => '{$foo->bar}',
],
'Type 2: object method call' => [
'testMarker' => '/* testMethod1 */',
'expectedContent' => '{$foo->bar()}',
],
'Type 2: closure function call' => [
'testMarker' => '/* testClosure1 */',
'expectedContent' => '{$foo()}',
],
'Type 2: chaining various syntaxes' => [
'testMarker' => '/* testChain1 */',
'expectedContent' => '{$foo[\'bar\']->baz()()}',
],
'Type 4: variable variables' => [
'testMarker' => '/* testVariableVar1 */',
'expectedContent' => '${$bar}',
],
'Type 4: variable constants' => [
'testMarker' => '/* testVariableVar2 */',
'expectedContent' => '${(foo)}',
],
'Type 4: object property' => [
'testMarker' => '/* testVariableVar3 */',
'expectedContent' => '${foo->bar}',
],
'Type 4: variable variable nested in array offset' => [
'testMarker' => '/* testNested1 */',
'expectedContent' => '${foo["${bar}"]}',
],
'Type 4: variable array offset nested in array offset' => [
'testMarker' => '/* testNested2 */',
'expectedContent' => '${foo["${bar[\'baz\']}"]}',
],
'Type 4: variable object property' => [
'testMarker' => '/* testNested3 */',
'expectedContent' => '${foo->{$baz}}',
],
'Type 4: variable object property - complex with single quotes' => [
'testMarker' => '/* testNested4 */',
'expectedContent' => '${foo->{${\'a\'}}}',
],
'Type 4: variable object property - complex with single and double quotes' => [
'testMarker' => '/* testNested5 */',
'expectedContent' => '${foo->{"${\'a\'}"}}',
],
];
}//end dataHeredocString()
}//end class
|
