erickskrauch/phpstan-yii2

PHPStan 的 Yii2 扩展

dev-master 2024-05-28 19:38 UTC

This package is auto-updated.

Last update: 2024-08-28 20:15:41 UTC


README

这是一个为 PHPStan 提供类型支持和规则的扩展,以便与 Yii2 框架 一起工作。它是 proget-hq/phpstan-yii2 的分叉。

Latest Version on Packagist Total Downloads Software License Build Status

它做什么?

  • 提供用于更好地分析数组形状的存根文件。
  • Yii:createObject() 提供数组形状分析。
  • yii\base\Configurable 类构造函数的最后一个数组参数提供分析。
  • YII_* 常量标记为动态。
  • 显著提高了对 ActiveRecordActiveQuery 的支持。
  • Yii::$container->get('service_id') 方法提供正确的返回类型。
  • 根据 $first 参数为 Yii::$app->request->headers->get('authorization') 方法提供正确的返回类型。
  • BaseObject 的获取器和设置器提供反射扩展。

安装

要使用此扩展,请在 Composer 中引入它

composer require --dev erickskrauch/phpstan-yii2

如果您还安装了 phpstan/extension-installer,则一切准备就绪!

手动安装

如果您不想使用 phpstan/extension-installer,请将 extension.neon 包含在项目 PHPStan 配置中

includes:
  - vendor/erickskrauch/phpstan-yii2/extension.neon
  - vendor/erickskrauch/phpstan-yii2/rules.neon

配置

您必须提供应用程序配置文件的路径。对于 Advanced 项目模板,路径可能如下所示

parameters:
  yii2:
    config_path: common/config/main.php

您可能希望为应用程序中可用的服务创建一个单独的 PHPStan 配置文件。但通常,common 就足够了,因为它包含应用程序任何模块中普遍可用的所有服务。