Skip to content

Commit a1f0f07

Browse files
paulbalandanpaulbalandan
authored
test: fix missingType.return errors (#9542)
1 parent 28d368b commit a1f0f07

37 files changed

+137
-378
lines changed

‎system/Config/Factories.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -513,6 +513,12 @@ public static function getBasename(string $alias): string
513513
/**
514514
* Gets component data for caching.
515515
*
516+
* @return array{
517+
* options: array<string, bool|string|null>,
518+
* aliases: array<string, class-string>,
519+
* instances: array<class-string, object>,
520+
* }
521+
*
516522
* @internal For caching only
517523
*/
518524
public static function getComponentInstances(string $component): array

‎system/Test/FilterTestTrait.php

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ protected function setUpFilterTestTrait(): void
120120
* @param FilterInterface|string $filter The filter instance, class, or alias
121121
* @param string $position "before" or "after"
122122
*
123-
* @phpstan-return Closure(list<string>|null=): mixed
123+
* @return Closure(list<string>|null=): mixed
124124
*/
125125
protected function getFilterCaller($filter, string $position): Closure
126126
{
@@ -268,6 +268,8 @@ protected function assertFilter(string $route, string $position, string $alias):
268268
* @param string $route The route to test
269269
* @param string $position "before" or "after"
270270
* @param string $alias Alias for the anticipated filter
271+
*
272+
* @return void
271273
*/
272274
protected function assertNotFilter(string $route, string $position, string $alias)
273275
{
@@ -286,6 +288,8 @@ protected function assertNotFilter(string $route, string $position, string $alia
286288
*
287289
* @param string $route The route to test
288290
* @param string $position "before" or "after"
291+
*
292+
* @return void
289293
*/
290294
protected function assertHasFilters(string $route, string $position)
291295
{
@@ -303,6 +307,8 @@ protected function assertHasFilters(string $route, string $position)
303307
*
304308
* @param string $route The route to test
305309
* @param string $position "before" or "after"
310+
*
311+
* @return void
306312
*/
307313
protected function assertNotHasFilters(string $route, string $position)
308314
{

‎system/Validation/Validation.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
use CodeIgniter\HTTP\RequestInterface;
2424
use CodeIgniter\Validation\Exceptions\ValidationException;
2525
use CodeIgniter\View\RendererInterface;
26-
use Config\Validation as ValidationConfig;
2726

2827
/**
2928
* Validator
@@ -96,7 +95,7 @@ class Validation implements ValidationInterface
9695
/**
9796
* Our configuration.
9897
*
99-
* @var ValidationConfig
98+
* @var object{ruleSets: list<class-string>}
10099
*/
101100
protected $config;
102101

@@ -110,7 +109,7 @@ class Validation implements ValidationInterface
110109
/**
111110
* Validation constructor.
112111
*
113-
* @param ValidationConfig $config
112+
* @param object{ruleSets: list<class-string>} $config
114113
*/
115114
public function __construct($config, RendererInterface $view)
116115
{

‎tests/system/API/ResponseTraitTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ private function createRequestAndResponse(string $routePath = '', array $userHea
108108
}
109109
}
110110

111-
protected function makeController(string $routePath = '', array $userHeaders = [])
111+
protected function makeController(string $routePath = '', array $userHeaders = []): object
112112
{
113113
$this->createRequestAndResponse($routePath, $userHeaders);
114114

@@ -659,7 +659,7 @@ public function testXMLResponseFormat(): void
659659
$this->assertSame($xmlFormatter->format($data), $this->response->getXML());
660660
}
661661

662-
private function invoke(object $controller, string $method, array $args = [])
662+
private function invoke(object $controller, string $method, array $args = []): object
663663
{
664664
$method = self::getPrivateMethodInvoker($controller, $method);
665665

‎tests/system/Cache/Handlers/FileHandlerTest.php

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ final class FileHandlerTest extends AbstractHandlerTestCase
3030
private static string $directory = 'FileHandler';
3131
private Cache $config;
3232

33-
private static function getKeyArray()
33+
/**
34+
* @return list<string>
35+
*/
36+
private static function getKeyArray(): array
3437
{
3538
return [
3639
self::$key1,
@@ -328,25 +331,16 @@ public function testSaveMode(int $int, string $string): void
328331
$this->assertSame($string, $mode);
329332
}
330333

334+
/**
335+
* @return iterable<int, array{int, numeric-string}>
336+
*/
331337
public static function provideSaveMode(): iterable
332338
{
333339
return [
334-
[
335-
0640,
336-
'640',
337-
],
338-
[
339-
0600,
340-
'600',
341-
],
342-
[
343-
0660,
344-
'660',
345-
],
346-
[
347-
0777,
348-
'777',
349-
],
340+
[0640, '640'],
341+
[0600, '600'],
342+
[0660, '660'],
343+
[0777, '777'],
350344
];
351345
}
352346

@@ -382,14 +376,19 @@ public function __construct()
382376
$this->config->file['storePath'] .= self::$directory;
383377

384378
parent::__construct($this->config);
379+
380+
helper('filesystem');
385381
}
386382

387-
public function getFileInfoTest()
383+
/**
384+
* @return array<string, bool|int|string>|null
385+
*/
386+
public function getFileInfoTest(): ?array
388387
{
389388
$tmpHandle = tmpfile();
390389
stream_get_meta_data($tmpHandle);
391390

392-
return $this->getFileInfo(stream_get_meta_data($tmpHandle)['uri'], [
391+
return get_file_info(stream_get_meta_data($tmpHandle)['uri'], [
393392
'name',
394393
'server_path',
395394
'size',

‎tests/system/Cache/Handlers/MemcachedHandlerTest.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@
2525
#[Group('CacheLive')]
2626
final class MemcachedHandlerTest extends AbstractHandlerTestCase
2727
{
28-
private static function getKeyArray()
28+
/**
29+
* @return list<string>
30+
*/
31+
private static function getKeyArray(): array
2932
{
3033
return [
3134
self::$key1,

‎tests/system/Cache/Handlers/PredisHandlerTest.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,10 @@ final class PredisHandlerTest extends AbstractHandlerTestCase
2626
{
2727
private Cache $config;
2828

29-
private static function getKeyArray()
29+
/**
30+
* @return list<string>
31+
*/
32+
private static function getKeyArray(): array
3033
{
3134
return [
3235
self::$key1,

‎tests/system/Cache/Handlers/RedisHandlerTest.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ final class RedisHandlerTest extends AbstractHandlerTestCase
2828
{
2929
private Cache $config;
3030

31-
private static function getKeyArray()
31+
/**
32+
* @return list<string>
33+
*/
34+
private static function getKeyArray(): array
3235
{
3336
return [
3437
self::$key1,

‎tests/system/Commands/CreateDatabaseTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ private function dropDatabase(): void
6464
}
6565
}
6666

67-
protected function getBuffer()
67+
protected function getBuffer(): string
6868
{
6969
return $this->getStreamFilterBuffer();
7070
}

‎tests/system/Commands/FilterCheckTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ protected function tearDown(): void
3737
parent::tearDown();
3838
}
3939

40-
protected function getBuffer()
40+
protected function getBuffer(): string
4141
{
4242
return $this->getStreamFilterBuffer();
4343
}

‎tests/system/Commands/HelpCommandTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ final class HelpCommandTest extends CIUnitTestCase
2525
{
2626
use StreamFilterTrait;
2727

28-
protected function getBuffer()
28+
protected function getBuffer(): string
2929
{
3030
return $this->getStreamFilterBuffer();
3131
}

‎tests/system/Commands/InfoCacheTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ protected function tearDown(): void
4141
config('Cache')->handler = 'file';
4242
}
4343

44-
protected function getBuffer()
44+
protected function getBuffer(): string
4545
{
4646
return $this->getStreamFilterBuffer();
4747
}

‎tests/system/Commands/RoutesTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ protected function tearDown(): void
4040
parent::tearDown();
4141
}
4242

43-
protected function getBuffer()
43+
protected function getBuffer(): string
4444
{
4545
return str_replace(PHP_EOL, "\n", $this->getStreamFilterBuffer());
4646
}

‎tests/system/Commands/Utilities/NamespacesTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ protected function tearDown(): void
4242
/**
4343
* @see https://regex101.com/r/l3lHfR/1
4444
*/
45-
protected function getBuffer()
45+
protected function getBuffer(): string
4646
{
4747
return preg_replace_callback('/(\|\s*[^|]+\s*\|\s*)(.*?)(\s*\|\s*[^|]+\s*\|)/', static function (array $matches): string {
4848
$matches[2] = str_replace(DIRECTORY_SEPARATOR, '/', $matches[2]);

‎tests/system/Config/FactoriesTest.php

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ protected function setUp(): void
4141
Factories::reset();
4242
}
4343

44-
protected function getFactoriesStaticProperty(...$params)
44+
protected function getFactoriesStaticProperty(...$params): mixed
4545
{
4646
// First parameter is the actual property
4747
$name = array_shift($params);
@@ -425,7 +425,14 @@ public function testDefineAndGet(): void
425425
$this->assertInstanceOf(EntityModel::class, $model);
426426
}
427427

428-
public function testGetComponentInstances()
428+
/**
429+
* @return array{
430+
* options: array<string, bool|string|null>,
431+
* aliases: array<string, class-string>,
432+
* instances: array<class-string, object>,
433+
* }
434+
*/
435+
public function testGetComponentInstances(): array
429436
{
430437
Factories::config('App');
431438
Factories::config(Database::class);
@@ -439,6 +446,19 @@ public function testGetComponentInstances()
439446
return $data;
440447
}
441448

449+
/**
450+
* @param array{
451+
* options: array<string, bool|string|null>,
452+
* aliases: array<string, class-string>,
453+
* instances: array<class-string, object>,
454+
* } $data
455+
*
456+
* @return array{
457+
* options: array<string, bool|string|null>,
458+
* aliases: array<string, class-string>,
459+
* instances: array<class-string, object>,
460+
* }
461+
*/
442462
#[Depends('testGetComponentInstances')]
443463
public function testSetComponentInstances(array $data)
444464
{
@@ -456,6 +476,13 @@ public function testSetComponentInstances(array $data)
456476
return $data;
457477
}
458478

479+
/**
480+
* @param array{
481+
* options: array<string, bool|string|null>,
482+
* aliases: array<string, class-string>,
483+
* instances: array<class-string, object>,
484+
* } $data
485+
*/
459486
#[Depends('testSetComponentInstances')]
460487
public function testIsUpdated(array $data): void
461488
{

‎tests/system/Entity/EntityTest.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1094,7 +1094,7 @@ public function testJsonSerializableEntity(): void
10941094
$this->assertSame(json_encode($entity->toArray()), json_encode($entity));
10951095
}
10961096

1097-
protected function getEntity()
1097+
private function getEntity(): object
10981098
{
10991099
return new class () extends Entity {
11001100
protected $attributes = [
@@ -1132,7 +1132,7 @@ public function getFakeBar(): string
11321132
};
11331133
}
11341134

1135-
protected function getNewSetterGetterEntity()
1135+
private function getNewSetterGetterEntity(): object
11361136
{
11371137
return new class () extends Entity {
11381138
protected $attributes = [
@@ -1178,7 +1178,7 @@ public function _getBar(): string
11781178
};
11791179
}
11801180

1181-
protected function getMappedEntity()
1181+
private function getMappedEntity(): object
11821182
{
11831183
return new class () extends Entity {
11841184
protected $attributes = [
@@ -1208,7 +1208,7 @@ protected function getSimple(): string
12081208
};
12091209
}
12101210

1211-
protected function getSwappedEntity()
1211+
private function getSwappedEntity(): object
12121212
{
12131213
return new class () extends Entity {
12141214
protected $attributes = [
@@ -1227,7 +1227,7 @@ protected function getSwappedEntity()
12271227
};
12281228
}
12291229

1230-
protected function getSimpleSwappedEntity()
1230+
private function getSimpleSwappedEntity(): object
12311231
{
12321232
return new class () extends Entity {
12331233
protected $attributes = [
@@ -1245,7 +1245,7 @@ protected function getSimpleSwappedEntity()
12451245
};
12461246
}
12471247

1248-
protected function getCastEntity($data = null): Entity
1248+
private function getCastEntity($data = null): object
12491249
{
12501250
return new class ($data) extends Entity {
12511251
protected $attributes = [
@@ -1303,7 +1303,7 @@ public function setSeventh(string $seventh): void
13031303
};
13041304
}
13051305

1306-
protected function getCastNullableEntity()
1306+
private function getCastNullableEntity(): object
13071307
{
13081308
return new class () extends Entity {
13091309
protected $attributes = [
@@ -1332,7 +1332,7 @@ protected function getCastNullableEntity()
13321332
};
13331333
}
13341334

1335-
protected function getCustomCastEntity()
1335+
private function getCustomCastEntity(): object
13361336
{
13371337
return new class () extends Entity {
13381338
protected $attributes = [

‎tests/system/Filters/fixtures/InvalidClass.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
class InvalidClass
1717
{
18-
public function index()
18+
public function index(): string
1919
{
2020
return 'bad';
2121
}

‎tests/system/HTTP/ContentSecurityPolicyTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ protected function prepare(bool $CSPEnabled = true): void
5454
$this->csp = $this->response->getCSP();
5555
}
5656

57-
protected function work(string $parm = 'Hello')
57+
protected function work(string $parm = 'Hello'): bool
5858
{
5959
$body = $parm;
6060
$this->response->setBody($body);

0 commit comments

Comments
 (0)