phpstan-src/tests/PHPStan/Analyser/nsrt/array-column.php at c97b61d20f50fae2d325f5ba2694559d1dfd3fa0 · VincentLanglet/phpstan-src · GitHub

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
<?php // lint < 8.2

namespace ArrayColumn;

use DOMElement;
use function PHPStan\Testing\assertType;


class ArrayColumnTest
{

	/** @param array<int, array<string, string>> $array */
	public function testArray1(array $array): void
	{
		assertType('list<string>', array_column($array, 'column'));
		assertType('list<string>', array_column($array, 'column', null));
		assertType('array<int|string, string>', array_column($array, 'column', 'key'));
		assertType('array<int|string, array<string, string>>', array_column($array, null, 'key'));
	}

	/** @param non-empty-array<int, array<string, string>> $array */
	public function testArray2(array $array): void
	{
		// Note: Array may still be empty!
		assertType('list<string>', array_column($array, 'column'));
		assertType('list<string>', array_column($array, 'column', null));
	}

	/** @param array{} $array */
	public function testArray3(array $array): void
	{
		assertType('array{}', array_column($array, 'column'));
		assertType('array{}', array_column($array, 'column', null));
		assertType('array{}', array_column($array, 'column', 'key'));
		assertType('array{}', array_column($array, null, 'key'));
	}

	/** @param array<int, array<string, float>> $array */
	public function testArray4(array $array): void
	{
		assertType('array<int, float>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, array<string, bool>> $array */
	public function testArray5(array $array): void
	{
		assertType('array<int, bool>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, array<string, true>> $array */
	public function testArray6(array $array): void
	{
		assertType('array<int, true>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, array<string, null>> $array */
	public function testArray7(array $array): void
	{
		assertType('array<\'\'|int, null>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, array<string, array>> $array */
	public function testArray8(array $array): void
	{
		assertType('array<int, array>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, array{column: string, key: string}> $array */
	public function testConstantArray1(array $array): void
	{
		assertType('list<string>', array_column($array, 'column'));
		assertType('list<string>', array_column($array, 'column', null));
		assertType('array<string, string>', array_column($array, 'column', 'key'));
		assertType('array<string, array{column: string, key: string}>', array_column($array, null, 'key'));
	}

	/** @param array<int, array{column: string, key: string}> $array */
	public function testConstantArray2(array $array): void
	{
		assertType('array{}', array_column($array, 'foo'));
		assertType('array{}', array_column($array, 'foo', null));
		assertType('array{}', array_column($array, 'foo', 'key'));
	}

	/** @param array{array{column: string, key: 'bar'}} $array */
	public function testConstantArray3(array $array): void
	{
		assertType("array{string}", array_column($array, 'column'));
		assertType("array{string}", array_column($array, 'column', null));
		assertType("array{bar: string}", array_column($array, 'column', 'key'));
		assertType("array{bar: array{column: string, key: 'bar'}}", array_column($array, null, 'key'));
	}

	/** @param array{array{column: string, key: string}} $array */
	public function testConstantArray4(array $array): void
	{
		assertType("non-empty-array<string, string>", array_column($array, 'column', 'key'));
		assertType("non-empty-array<string, array{column: string, key: string}>", array_column($array, null, 'key'));
	}

	/** @param array<int, array{column?: 'foo', key?: 'bar'}> $array */
	public function testConstantArray5(array $array): void
	{
		assertType("list<'foo'>", array_column($array, 'column'));
		assertType("list<'foo'>", array_column($array, 'column', null));
		assertType("array<'bar'|int, 'foo'>", array_column($array, 'column', 'key'));
		assertType("array<'bar'|int, array{column?: 'foo', key?: 'bar'}>", array_column($array, null, 'key'));
	}

	/** @param array<int, array{column1: string, column2: bool}> $array */
	public function testConstantArray6(array $array): void
	{
		assertType('list<bool|string>', array_column($array, mt_rand(0, 1) === 0 ? 'column1' : 'column2'));
		assertType('list<bool|string>', array_column($array, mt_rand(0, 1) === 0 ? 'column1' : 'column2', null));
	}

	/** @param non-empty-array<int, array{column: string, key: string}> $array */
	public function testConstantArray7(array $array): void
	{
		assertType('non-empty-list<string>', array_column($array, 'column'));
		assertType('non-empty-list<string>', array_column($array, 'column', null));
		assertType('non-empty-array<string, string>', array_column($array, 'column', 'key'));
		assertType('non-empty-array<string, array{column: string, key: string}>', array_column($array, null, 'key'));
	}

	/** @param array<int, array{column: string, key: float}> $array */
	public function testConstantArray8(array $array): void
	{
		assertType('array<int, string>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, array{column: string, key: bool}> $array */
	public function testConstantArray9(array $array): void
	{
		assertType('array<0|1, string>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, array{column: string, key: true}> $array */
	public function testConstantArray10(array $array): void
	{
		assertType('array<1, string>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, array{column: string, key: null}> $array */
	public function testConstantArray11(array $array): void
	{
		assertType('array<\'\', string>', array_column($array, 'column', 'key'));
	}

	/** @param array{0?: array{column: 'foo', key: 'bar'}} $array */
	public function testConstantArray12(array $array): void
	{
		assertType("array{0?: 'foo'}", array_column($array, 'column'));
		assertType("array{0?: 'foo'}", array_column($array, 'column', null));
		assertType("array{bar?: 'foo'}", array_column($array, 'column', 'key'));
	}

	/** @param array{0?: array{column: 'foo1', key: 'bar1'}, 1?: array{column: 'foo2', key: 'bar2'}} $array */
	public function testConstantArray13(array $array): void
	{
		assertType("list{0?: 'foo1'|'foo2', 1?: 'foo2'}", array_column($array, 'column'));
		assertType("list{0?: 'foo1'|'foo2', 1?: 'foo2'}", array_column($array, 'column', null));
		assertType("array{bar1?: 'foo1', bar2?: 'foo2'}", array_column($array, 'column', 'key'));
	}

	/** @param array{0?: array{column: 'foo1', key: 'bar1'}, 1: array{column: 'foo2', key: 'bar2'}} $array */
	public function testConstantArray14(array $array): void
	{
		assertType("array{0: 'foo1'|'foo2', 1?: 'foo2'}", array_column($array, 'column'));
		assertType("array{0: 'foo1'|'foo2', 1?: 'foo2'}", array_column($array, 'column', null));
		assertType("array{bar1?: 'foo1', bar2: 'foo2'}", array_column($array, 'column', 'key'));
	}

	// These cases aren't handled precisely and will return non-constant arrays.

	/** @param array{array{column?: 'foo', key: 'bar'}} $array */
	public function testImprecise1(array $array): void
	{
		assertType("list<'foo'>", array_column($array, 'column'));
		assertType("list<'foo'>", array_column($array, 'column', null));
		assertType("array<'bar', 'foo'>", array_column($array, 'column', 'key'));
		assertType("array{bar: array{column?: 'foo', key: 'bar'}}", array_column($array, null, 'key'));
	}

	/** @param array{array{column: 'foo', key?: 'bar'}} $array */
	public function testImprecise2(array $array): void
	{
		assertType("non-empty-array<'bar'|int, 'foo'>", array_column($array, 'column', 'key'));
		assertType("non-empty-array<'bar'|int, array{column: 'foo', key?: 'bar'}>", array_column($array, null, 'key'));
	}

	/** @param array{array{column: 'foo', key: 'bar'}}|array<int, array<string, string>> $array */
	public function testImprecise3(array $array): void
	{
		assertType('list<string>', array_column($array, 'column'));
		assertType('list<string>', array_column($array, 'column', null));
		assertType('array<int|string, string>', array_column($array, 'column', 'key'));
	}

	/** @param array<int, DOMElement> $array */
	public function testImprecise5(array $array): void
	{
		assertType('list<string>', array_column($array, 'nodeName'));
		assertType('list<string>', array_column($array, 'nodeName', null));
		assertType('array<string, string>', array_column($array, 'nodeName', 'tagName'));
		assertType('array<string, DOMElement>', array_column($array, null, 'tagName'));
		assertType('list', array_column($array, 'foo'));
		assertType('list', array_column($array, 'foo', null));
		assertType('array<string, mixed>', array_column($array, 'foo', 'tagName'));
		assertType('array<string>', array_column($array, 'nodeName', 'foo'));
		assertType('array<DOMElement>', array_column($array, null, 'foo'));
	}

	/** @param non-empty-array<int, DOMElement> $array */
	public function testObjects1(array $array): void
	{
		assertType('non-empty-list<string>', array_column($array, 'nodeName'));
		assertType('non-empty-list<string>', array_column($array, 'nodeName', null));
		assertType('non-empty-array<string, string>', array_column($array, 'nodeName', 'tagName'));
		assertType('non-empty-array<string, DOMElement>', array_column($array, null, 'tagName'));
		assertType('list', array_column($array, 'foo'));
		assertType('list', array_column($array, 'foo', null));
		assertType('array<string, mixed>', array_column($array, 'foo', 'tagName'));
		assertType('non-empty-array<string>', array_column($array, 'nodeName', 'foo'));
		assertType('non-empty-array<DOMElement>', array_column($array, null, 'foo'));
	}

	/** @param array{DOMElement} $array */
	public function testObjects2(array $array): void
	{
		assertType('array{string}', array_column($array, 'nodeName'));
		assertType('array{string}', array_column($array, 'nodeName', null));
		assertType('non-empty-array<string, string>', array_column($array, 'nodeName', 'tagName'));
		assertType('non-empty-array<string, DOMElement>', array_column($array, null, 'tagName'));
		assertType('list', array_column($array, 'foo'));
		assertType('list', array_column($array, 'foo', null));
		assertType('array<string, mixed>', array_column($array, 'foo', 'tagName'));
		assertType('non-empty-array<string>', array_column($array, 'nodeName', 'foo'));
		assertType('non-empty-array<DOMElement>', array_column($array, null, 'foo'));
	}

}

final class Foo
{

	/** @param array<int, self> $a */
	public function doFoo(array $a): void
	{
		assertType('list', array_column($a, 'nodeName'));
		assertType('array', array_column($a, 'nodeName', 'tagName'));
	}

}