forked from magento/magento-coding-standard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathClassPropertyPHPDocFormattingUnitTest.inc
228 lines (189 loc) · 4.15 KB
/
ClassPropertyPHPDocFormattingUnitTest.inc
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
<?php
class Foo
{
/**
* @var Foo
*/
private $_classAttribute = '';
/**
* Foo
*/
public $_withoutClassAttribute = '';
/**
* @var Test
*
* Short Description
*/
protected $_classAttributeWithShortDescription = '';
/**
* @var
*/
private $_emptyClassAttributeContent = '';
/**
* @var Foo
* @var Bar
*/
private $_multipleClassAttribute = '';
private $_missingDocBlockClassAttribute = '';
}
class Bar {
/**
* @var variableHasAlreadyHaveProtectedClassMember
*
* Short Description
*/
public $variableHasAlreadyHavePublicClassMember;
/**
* @var variableHasAlreadyHavePrivateClassMember
*
* Short Description
*/
private $variableHasAlreadyHavePrivateClassMember;
/**
* @var variableHasAlreadyHaveProtectedClassMember
*
* Short Description
*/
protected $variableHasAlreadyHaveProtectedClassMember;
/**
* @var className
*
* Variable name
*/
private $variableName;
/**
* Correctly Formatted Protected Class Member
*
* @var correctlyFormattedProtectedClassMember
*/
protected $correctlyFormattedProtectedClassMember;
/**
* anotherCorrectlyFormattedProtectedClassMember
*
* @var anotherCorrectlyFormattedProtectedClassMember
*/
protected $anotherCorrectlyFormattedProtectedClassMember;
}
class correctlyFormattedClassMemberDocBlock
{
/**
* @var correctlyFormattedPublicClassMember
*/
public $correctlyFormattedPublicClassMember;
/**
* @var correctlyFormattedPrivateClassMember
*/
private $correctlyFormattedPrivateClassMember;
/**
* @var correctlyFormattedProtectedClassMember
*/
protected $correctlyFormattedProtectedClassMember;
/**
* @var Array|\Foo_BAR
*/
protected $array;
/**
* @var \FOO\BAR\TEST\Class\\FooBarInterface|
* \FooObject_TEST_C
*/
private $testObject;
/**
* Fallback factory
*
* @var RulePool
*/
protected $rulePool;
/**
* @var \Magento\Store\Model\StoreManager
*/
private \Magento\Store\Model\StoreManager $decoratedStoreManager;
/*
* @var \Magento\Eav\Model\Entity\Attribute\SetFactory
*/
private $attributeSetFactory;
/**
* A description that includes test which is the same name as the variable is allowed
*
* @var test
*/
protected $test;
/**
* @var string
*/
protected string $test1;
/**
* Ensure that nullable sign in the property type hint declaration is interpreted correctly
*
* @var string|null
*/
protected ?string $test2;
/**
* @var string
* @deprecated
*/
protected string $badlyDeprecated;
/**
* @var string
* @deprecated Why not
*/
protected string $incorrectlyDeprecated;
/**
* @var string
* @deprecated
* @see
*/
protected string $inaccurately;
/**
* @var string
* @deprecated No reference specified
* @see
*/
protected string $mistakenly;
/**
* @var string
* @deprecated No reference specified
* @see Some reference
*/
protected string $correctly;
/**
* @var string
* @deprecated
* @see Some other reference
*/
protected string $alsoCorrect;
/**
* @var string
* @see
*/
protected string $shouldBeCorrect;
/**
* @var string
* @see Message with some reference
*/
protected string $itIsCorrect;
/**
* @var string
* @deprecated This property will be removed in version 1.0.0 without replacement
*/
protected string $deprecatedWithKeyword;
/**
* @var string
*/
protected readonly string $readOnlyString;
/**
* @var int
*/
protected readonly int $readOnlyInteger;
/**
* @var Foo|Bar
*/
protected Foo|Bar $unionType;
/**
* @var Bar&Foo
*/
protected Foo&Bar $pureIntersectionType;
/**
* @var array|(Bar&Foo)
*/
protected (Foo&Bar)|array $unionIntersectionType;
}