bug: phpstan-codeigniter forces a model class extends `CodeIgniter\Model`

[kenjis]

PHP Version

8.1

PHPStan CodeIgniter Version

v1.4.2.70400

PHPStan Version

1.10.39

What happened?

 ------ ---------------------------------------------------------------------------------------------------- 
  Line   app/Controllers/ActionsController.php                                                               
 ------ ---------------------------------------------------------------------------------------------------- 
  46     Argument #1 $name ('App\\Models\\NotificationMutedModel') passed to function model does not extend  
         CodeIgniter\\Model.                                                                                 
 ------ ----------------------------------------------------------------------------------------------------

https://github.com/kenjis/forum-example/blob/37a339f050ee2c40ed452e6570cef188dc0f90a0/app/Controllers/ActionsController.php#L46
https://github.com/kenjis/forum-example/blob/37a339f050ee2c40ed452e6570cef188dc0f90a0/app/Models/NotificationMutedModel.php#L11

Minimum Reproduction Script

git clone https://github.com/kenjis/forum-example --branch=add-phpstan-codeigniter
cd forum-example/
composer install
vendor/bin/phpstan

Expected Output

No error on ActionsController

[paulbalandan]

You can turn this rule off:

Checks if the string argument passed to config() or model() function is a valid class string extending CodeIgniter\Config\BaseConfig or CodeIgniter\Model, respectively. This can be turned off by setting codeigniter.checkArgumentTypeOfFactories: false in your phpstan.neon.

[kenjis]

The config also disables the config() class checks like the following:

 ------ --------------------------------------------------------------------------------- 
  Line   app/Controllers/Home.php                                                         
 ------ --------------------------------------------------------------------------------- 
  11     Argument #1 $name ('Config\\Modules') passed to function config does not extend  
         CodeIgniter\\Config\\BaseConfig.                                                 
 ------ --------------------------------------------------------------------------------- 

[paulbalandan]

This is conditionally activated here:

phpstan-codeigniter/extension.neon

Lines 84 to 85 in d4f77ab

	CodeIgniter\PHPStan\Rules\Functions\FactoriesFunctionArgumentTypeRule:
	phpstan.rules.rule: %codeigniter.checkArgumentTypeOfFactories%

If I understand correctly, you want to enable check for config() but not for model(). The non-BC way to do it that I can think of is too add 2 new options (added to extension.neon) that will be passed to the constructor of CodeIgniter\PHPStan\Rules\Functions\FactoriesFunctionArgumentTypeRule. Then from there check if the resolved function name is either config or model then check if the user wants to bypass the check using the 2 new constructor parameters.

[kenjis]

you want to enable check for config() but not for model().

Yes!
config() checking is needed if we use Config caching, and using config() to non-BaseConfig class is probably meaningless and using new is faster.
But model() checking is not needed. Because CodeIgniter does not force us to extend the model.
https://codeigniter4.github.io/CodeIgniter4/models/model.html#manual-model-creation

By the way, what was the type checking for model() implemented for in the first place?

[paulbalandan]

Because factories has a verifyInstanceof option. The opt-out feature strictly checks the instance in case that option is used.
Think of it like "strict-rules" for this extension.