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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
|
<?php
/**
* Tests that PHPCS native annotations in docblocks are tokenized correctly.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2024 PHPCSStandards and contributors
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment;
/**
* Tests that PHPCS native annotations in docblocks are tokenized correctly.
*
* @covers PHP_CodeSniffer\Tokenizers\Comment
*/
final class PhpcsAnnotationsInDocBlockTest extends CommentTestCase
{
/**
* Data provider.
*
* @see testDocblockOpenerCloser()
*
* @return array<string, array<string, string|int|array<int>>>
*/
public static function dataDocblockOpenerCloser()
{
return [
'Single-line: @phpcs:ignoreFile annotation' => [
'marker' => '/* testSingleLineDocIgnoreFileAnnotation */',
'closerOffset' => 3,
'expectedTags' => [],
],
'Single-line: @phpcs:ignore annotation' => [
'marker' => '/* testSingleLineDocIgnoreAnnotation */',
'closerOffset' => 3,
'expectedTags' => [],
],
'Single-line: @phpcs:disable annotation' => [
'marker' => '/* testSingleLineDocDisableAnnotation */',
'closerOffset' => 3,
'expectedTags' => [],
],
'Single-line: @phpcs:enable annotation; no whitespace' => [
'marker' => '/* testSingleLineDocEnableAnnotationNoWhitespace */',
'closerOffset' => 2,
'expectedTags' => [],
],
'Multi-line: @phpcs:ignoreFile at the start' => [
'marker' => '/* testMultiLineDocIgnoreFileAnnotationAtStart */',
'closerOffset' => 13,
'expectedTags' => [],
],
'Multi-line: @phpcs:ignore at the start' => [
'marker' => '/* testMultiLineDocIgnoreAnnotationAtStart */',
'closerOffset' => 13,
'expectedTags' => [10],
],
'Multi-line: @phpcs:disable at the start' => [
'marker' => '/* testMultiLineDocDisableAnnotationAtStart */',
'closerOffset' => 13,
'expectedTags' => [],
],
'Multi-line: @phpcs:enable at the start' => [
'marker' => '/* testMultiLineDocEnableAnnotationAtStart */',
'closerOffset' => 18,
'expectedTags' => [13],
],
'Multi-line: @phpcs:ignoreFile in the middle' => [
'marker' => '/* testMultiLineDocIgnoreFileAnnotationInMiddle */',
'closerOffset' => 21,
'expectedTags' => [],
],
'Multi-line: @phpcs:ignore in the middle' => [
'marker' => '/* testMultiLineDocIgnoreAnnotationInMiddle */',
'closerOffset' => 23,
'expectedTags' => [5],
],
'Multi-line: @phpcs:disable in the middle' => [
'marker' => '/* testMultiLineDocDisableAnnotationInMiddle */',
'closerOffset' => 26,
'expectedTags' => [21],
],
'Multi-line: @phpcs:enable in the middle' => [
'marker' => '/* testMultiLineDocEnableAnnotationInMiddle */',
'closerOffset' => 24,
'expectedTags' => [21],
],
'Multi-line: @phpcs:ignoreFile at the end' => [
'marker' => '/* testMultiLineDocIgnoreFileAnnotationAtEnd */',
'closerOffset' => 16,
'expectedTags' => [5],
],
'Multi-line: @phpcs:ignore at the end' => [
'marker' => '/* testMultiLineDocIgnoreAnnotationAtEnd */',
'closerOffset' => 16,
'expectedTags' => [],
],
'Multi-line: @phpcs:disable at the end' => [
'marker' => '/* testMultiLineDocDisableAnnotationAtEnd */',
'closerOffset' => 18,
'expectedTags' => [5],
],
'Multi-line: @phpcs:enable at the end' => [
'marker' => '/* testMultiLineDocEnableAnnotationAtEnd */',
'closerOffset' => 16,
'expectedTags' => [],
],
];
}//end dataDocblockOpenerCloser()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS ignoreFile annotation.
*
* @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment.
*
* @return void
*/
public function testSingleLineDocIgnoreFileAnnotation()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_IGNORE_FILE => '@phpcs:ignoreFile '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testSingleLineDocIgnoreFileAnnotation()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS ignore annotation.
*
* @return void
*/
public function testSingleLineDocIgnoreAnnotation()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_IGNORE => '@phpcs:ignore Stnd.Cat.SniffName -- With reason '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testSingleLineDocIgnoreAnnotation()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS disable annotation.
*
* @return void
*/
public function testSingleLineDocDisableAnnotation()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_DISABLE => '@phpcs:disable Stnd.Cat.SniffName,Stnd.Other '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testSingleLineDocDisableAnnotation()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS enable annotation.
*
* @return void
*/
public function testSingleLineDocEnableAnnotationNoWhitespace()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_PHPCS_ENABLE => '@phpcs:enable Stnd.Cat.SniffName'],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testSingleLineDocEnableAnnotationNoWhitespace()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS ignoreFile annotation at the start.
*
* @return void
*/
public function testMultiLineDocIgnoreFileAnnotationAtStart()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_IGNORE_FILE => '@phpcs:ignoreFile'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Something.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocIgnoreFileAnnotationAtStart()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS ignore annotation at the start.
*
* @return void
*/
public function testMultiLineDocIgnoreAnnotationAtStart()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_IGNORE => '@phpcs:ignore Stnd.Cat.SniffName'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@tag'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocIgnoreAnnotationAtStart()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS disable annotation at the start.
*
* @return void
*/
public function testMultiLineDocDisableAnnotationAtStart()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_DISABLE => '@phpcs:disable Stnd.Cat.SniffName -- Ensure PHPCS annotations are also retokenized correctly.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Something.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocDisableAnnotationAtStart()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS enable annotation at the start.
*
* @return void
*/
public function testMultiLineDocEnableAnnotationAtStart()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_ENABLE => '@phpcs:enable Stnd.Cat,Stnd.Other'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@tag'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'With description.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocEnableAnnotationAtStart()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS ignoreFile annotation in the middle.
*
* @return void
*/
public function testMultiLineDocIgnoreFileAnnotationInMiddle()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_IGNORE_FILE => '@phpcs:ignoreFile'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Something.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocIgnoreFileAnnotationInMiddle()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS ignore annotation in the middle.
*
* @return void
*/
public function testMultiLineDocIgnoreAnnotationInMiddle()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@tagBefore'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'With Description'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_IGNORE => '@phpcs:ignore Stnd.Cat.SniffName'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Something.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocIgnoreAnnotationInMiddle()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS disable annotation in the middle.
*
* @return void
*/
public function testMultiLineDocDisableAnnotationInMiddle()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_DISABLE => '@phpcs:disable Stnd.Cat.SniffName -- Ensure PHPCS annotations are also retokenized correctly.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@tagAfter'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'With Description'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocDisableAnnotationInMiddle()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS enable annotation in the middle.
*
* @return void
*/
public function testMultiLineDocEnableAnnotationInMiddle()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_ENABLE => '@phpcs:enable Stnd.Cat,Stnd.Other'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@tagAfter'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocEnableAnnotationInMiddle()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS ignoreFile annotation at the end.
*
* @return void
*/
public function testMultiLineDocIgnoreFileAnnotationAtEnd()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@tagBefore'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_IGNORE_FILE => '@phpcs:ignoreFile'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocIgnoreFileAnnotationAtEnd()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS ignore annotation at the end.
*
* @return void
*/
public function testMultiLineDocIgnoreAnnotationAtEnd()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_IGNORE => '@phpcs:ignore Stnd.Cat.SniffName'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocIgnoreAnnotationAtEnd()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS disable annotation at the end.
*
* @return void
*/
public function testMultiLineDocDisableAnnotationAtEnd()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_TAG => '@tagBefore'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'With Description.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_DISABLE => '@phpcs:disable Stnd.Cat.SniffName -- Ensure PHPCS annotations are also retokenized correctly.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocDisableAnnotationAtEnd()
/**
* Verify tokenization of a single line DocBlock containing a PHPCS enable annotation at the end.
*
* @return void
*/
public function testMultiLineDocEnableAnnotationAtEnd()
{
$expectedSequence = [
[T_DOC_COMMENT_OPEN_TAG => '/**'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_STAR => '*'],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_PHPCS_ENABLE => '@phpcs:enable Stnd.Cat,Stnd.Other'],
[T_DOC_COMMENT_WHITESPACE => "\n"],
[T_DOC_COMMENT_WHITESPACE => ' '],
[T_DOC_COMMENT_CLOSE_TAG => '*/'],
];
$target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG);
$this->checkTokenSequence($target, $expectedSequence);
}//end testMultiLineDocEnableAnnotationAtEnd()
}//end class
|
