Skip to content

Commit 543c2a8

Browse files
kenjiskenjis
committed
docs: fix @param array type for Commands
1 parent 8409157 commit 543c2a8

30 files changed

Lines changed: 55 additions & 105 deletions

‎phpstan-baseline.php‎

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -196,16 +196,6 @@
196196
'count' => 1,
197197
'path' => __DIR__ . '/system/Commands/Database/CreateDatabase.php',
198198
];
199-
$ignoreErrors[] = [
200-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Database\\\\CreateDatabase\\:\\:\\$arguments is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$arguments\\.$#',
201-
'count' => 1,
202-
'path' => __DIR__ . '/system/Commands/Database/CreateDatabase.php',
203-
];
204-
$ignoreErrors[] = [
205-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Database\\\\CreateDatabase\\:\\:\\$options is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$options\\.$#',
206-
'count' => 1,
207-
'path' => __DIR__ . '/system/Commands/Database/CreateDatabase.php',
208-
];
209199
$ignoreErrors[] = [
210200
'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
211201
'count' => 1,
@@ -216,11 +206,6 @@
216206
'count' => 1,
217207
'path' => __DIR__ . '/system/Commands/Database/MigrateStatus.php',
218208
];
219-
$ignoreErrors[] = [
220-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Database\\\\MigrateStatus\\:\\:\\$options is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$options\\.$#',
221-
'count' => 1,
222-
'path' => __DIR__ . '/system/Commands/Database/MigrateStatus.php',
223-
];
224209
$ignoreErrors[] = [
225210
'message' => '#^Parameter \\#1 \\$params \\(array\\<string, mixed\\>\\) of method CodeIgniter\\\\Commands\\\\Database\\\\MigrateStatus\\:\\:run\\(\\) should be contravariant with parameter \\$params \\(array\\<int\\|string, string\\|null\\>\\) of method CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:run\\(\\)$#',
226211
'count' => 1,
@@ -231,11 +216,6 @@
231216
'count' => 1,
232217
'path' => __DIR__ . '/system/Commands/Database/Seed.php',
233218
];
234-
$ignoreErrors[] = [
235-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Database\\\\Seed\\:\\:\\$arguments is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$arguments\\.$#',
236-
'count' => 1,
237-
'path' => __DIR__ . '/system/Commands/Database/Seed.php',
238-
];
239219
$ignoreErrors[] = [
240220
'message' => '#^Method CodeIgniter\\\\Commands\\\\Database\\\\ShowTableInfo\\:\\:showAllTables\\(\\) has no return type specified\\.$#',
241221
'count' => 1,
@@ -246,16 +226,6 @@
246226
'count' => 1,
247227
'path' => __DIR__ . '/system/Commands/Database/ShowTableInfo.php',
248228
];
249-
$ignoreErrors[] = [
250-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Database\\\\ShowTableInfo\\:\\:\\$arguments is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$arguments\\.$#',
251-
'count' => 1,
252-
'path' => __DIR__ . '/system/Commands/Database/ShowTableInfo.php',
253-
];
254-
$ignoreErrors[] = [
255-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Database\\\\ShowTableInfo\\:\\:\\$options is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$options\\.$#',
256-
'count' => 1,
257-
'path' => __DIR__ . '/system/Commands/Database/ShowTableInfo.php',
258-
];
259229
$ignoreErrors[] = [
260230
'message' => '#^Accessing offset \'encryption\\.key\' directly on \\$_SERVER is discouraged\\.$#',
261231
'count' => 1,
@@ -756,26 +726,11 @@
756726
'count' => 3,
757727
'path' => __DIR__ . '/system/Commands/Utilities/Environment.php',
758728
];
759-
$ignoreErrors[] = [
760-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Utilities\\\\Environment\\:\\:\\$arguments is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$arguments\\.$#',
761-
'count' => 1,
762-
'path' => __DIR__ . '/system/Commands/Utilities/Environment.php',
763-
];
764-
$ignoreErrors[] = [
765-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Utilities\\\\FilterCheck\\:\\:\\$arguments is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$arguments\\.$#',
766-
'count' => 1,
767-
'path' => __DIR__ . '/system/Commands/Utilities/FilterCheck.php',
768-
];
769729
$ignoreErrors[] = [
770730
'message' => '#^Short ternary operator is not allowed\\. Use null coalesce operator if applicable or consider using long ternary\\.$#',
771731
'count' => 1,
772732
'path' => __DIR__ . '/system/Commands/Utilities/Namespaces.php',
773733
];
774-
$ignoreErrors[] = [
775-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Utilities\\\\Publish\\:\\:\\$arguments is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$arguments\\.$#',
776-
'count' => 1,
777-
'path' => __DIR__ . '/system/Commands/Utilities/Publish.php',
778-
];
779734
$ignoreErrors[] = [
780735
'message' => '#^Accessing offset \'HTTP_HOST\' directly on \\$_SERVER is discouraged\\.$#',
781736
'count' => 1,
@@ -796,11 +751,6 @@
796751
'count' => 3,
797752
'path' => __DIR__ . '/system/Commands/Utilities/Routes.php',
798753
];
799-
$ignoreErrors[] = [
800-
'message' => '#^PHPDoc type array\\<string, string\\> of property CodeIgniter\\\\Commands\\\\Utilities\\\\Routes\\:\\:\\$options is not the same as PHPDoc type array of overridden property CodeIgniter\\\\CLI\\\\BaseCommand\\:\\:\\$options\\.$#',
801-
'count' => 1,
802-
'path' => __DIR__ . '/system/Commands/Utilities/Routes.php',
803-
];
804754
$ignoreErrors[] = [
805755
'message' => '#^Implicit array creation is not allowed \\- variable \\$filters might not exist\\.$#',
806756
'count' => 1,

‎system/CLI/BaseCommand.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
/**
2020
* BaseCommand is the base class used in creating CLI commands.
2121
*
22-
* @property array $arguments
23-
* @property Commands $commands
24-
* @property string $description
25-
* @property string $group
26-
* @property LoggerInterface $logger
27-
* @property string $name
28-
* @property array $options
29-
* @property string $usage
22+
* @property array<string, string> $arguments
23+
* @property Commands $commands
24+
* @property string $description
25+
* @property string $group
26+
* @property LoggerInterface $logger
27+
* @property string $name
28+
* @property array<string, string> $options
29+
* @property string $usage
3030
*/
3131
abstract class BaseCommand
3232
{
@@ -62,14 +62,14 @@ abstract class BaseCommand
6262
/**
6363
* the Command's options description
6464
*
65-
* @var array
65+
* @var array<string, string>
6666
*/
6767
protected $options = [];
6868

6969
/**
7070
* the Command's Arguments description
7171
*
72-
* @var array
72+
* @var array<string, string>
7373
*/
7474
protected $arguments = [];
7575

‎system/Commands/Cache/ClearCache.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class ClearCache extends BaseCommand
5252
/**
5353
* the Command's Arguments
5454
*
55-
* @var array
55+
* @var array<string, string>
5656
*/
5757
protected $arguments = [
5858
'driver' => 'The cache driver to use',

‎system/Commands/Database/Migrate.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class Migrate extends BaseCommand
5353
/**
5454
* the Command's Options
5555
*
56-
* @var array
56+
* @var array<string, string>
5757
*/
5858
protected $options = [
5959
'-n' => 'Set migration namespace',

‎system/Commands/Database/MigrateRefresh.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class MigrateRefresh extends BaseCommand
5252
/**
5353
* the Command's Options
5454
*
55-
* @var array
55+
* @var array<string, string>
5656
*/
5757
protected $options = [
5858
'-n' => 'Set migration namespace',

‎system/Commands/Database/MigrateRollback.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class MigrateRollback extends BaseCommand
5454
/**
5555
* the Command's Options
5656
*
57-
* @var array
57+
* @var array<string, string>
5858
*/
5959
protected $options = [
6060
'-b' => 'Specify a batch to roll back to; e.g. "3" to return to batch #3',

‎system/Commands/Encryption/GenerateKey.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class GenerateKey extends BaseCommand
5252
/**
5353
* The command's options
5454
*
55-
* @var array
55+
* @var array<string, string>
5656
*/
5757
protected $options = [
5858
'--force' => 'Force overwrite existing key in `.env` file.',

‎system/Commands/Generators/CellGenerator.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class CellGenerator extends BaseCommand
5252
/**
5353
* The Command's Arguments
5454
*
55-
* @var array
55+
* @var array<string, string>
5656
*/
5757
protected $arguments = [
5858
'name' => 'The cell class name.',
@@ -61,7 +61,7 @@ class CellGenerator extends BaseCommand
6161
/**
6262
* The Command's Options
6363
*
64-
* @var array
64+
* @var array<string, string>
6565
*/
6666
protected $options = [
6767
'--namespace' => 'Set root namespace. Default: "APP_NAMESPACE".',

‎system/Commands/Generators/CommandGenerator.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class CommandGenerator extends BaseCommand
5353
/**
5454
* The Command's Arguments
5555
*
56-
* @var array
56+
* @var array<string, string>
5757
*/
5858
protected $arguments = [
5959
'name' => 'The command class name.',
@@ -62,7 +62,7 @@ class CommandGenerator extends BaseCommand
6262
/**
6363
* The Command's Options
6464
*
65-
* @var array
65+
* @var array<string, string>
6666
*/
6767
protected $options = [
6868
'--command' => 'The command name. Default: "command:name"',

‎system/Commands/Generators/ConfigGenerator.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class ConfigGenerator extends BaseCommand
5252
/**
5353
* The Command's Arguments
5454
*
55-
* @var array
55+
* @var array<string, string>
5656
*/
5757
protected $arguments = [
5858
'name' => 'The config class name.',
@@ -61,7 +61,7 @@ class ConfigGenerator extends BaseCommand
6161
/**
6262
* The Command's Options
6363
*
64-
* @var array
64+
* @var array<string, string>
6565
*/
6666
protected $options = [
6767
'--namespace' => 'Set root namespace. Default: "APP_NAMESPACE".',

0 commit comments

Comments
 (0)