PHPStan Disallowed Calls 项目使用教程

PHPStan Disallowed Calls 项目使用教程

phpstan-disallowed-callsPHPStan rules to detect disallowed method & function calls, constant, namespace, attribute & superglobal usages项目地址:https://gitcode.com/gh_mirrors/ph/phpstan-disallowed-calls

1. 项目的目录结构及介绍

phpstan-disallowed-calls/
├── LICENSE
├── README.md
├── composer.json
├── disallowed-dangerous-calls.neon
├── phpstan.neon
└── phpunit.xml

• LICENSE: 项目的许可证文件，采用 MIT 许可证。
• README.md: 项目的说明文档，包含项目的基本介绍和使用方法。
• composer.json: Composer 配置文件，定义了项目的依赖和元数据。
• disallowed-dangerous-calls.neon: 项目的主要配置文件，用于定义不允许调用的函数、方法和常量。
• phpstan.neon: PHPStan 的配置文件，用于配置静态分析工具 PHPStan。
• phpunit.xml: PHPUnit 的配置文件，用于配置单元测试工具 PHPUnit。

2. 项目的启动文件介绍

项目没有明确的“启动文件”，因为 PHPStan Disallowed Calls 是一个静态分析工具的扩展，主要通过配置文件来定义和执行。项目的核心功能是通过 disallowed-dangerous-calls.neon 文件来实现的。

3. 项目的配置文件介绍

disallowed-dangerous-calls.neon

该文件是 PHPStan Disallowed Calls 扩展的核心配置文件，用于定义不允许在生产代码中使用的函数、方法和常量。以下是一个示例配置：

parameters:
    disallowedFunctionCalls:
        -
            function: 'var_dump'
            message: 'Calling var_dump() is forbidden, use logger instead'
        -
            function: 'print_r'
            message: 'Calling print_r() is forbidden, use logger instead'

• function: 指定不允许调用的函数名。
• message: 当检测到不允许的调用时，显示的错误消息。

phpstan.neon

该文件是 PHPStan 的配置文件，用于配置静态分析工具 PHPStan。通常，你需要在 phpstan.neon 中包含 disallowed-dangerous-calls.neon 文件：

includes:
    - vendor/spaze/phpstan-disallowed-calls/disallowed-dangerous-calls.neon

composer.json

该文件是 Composer 的配置文件，定义了项目的依赖和元数据。以下是一个示例配置：

{
    "name": "spaze/phpstan-disallowed-calls",
    "description": "PHPStan rules to detect disallowed calls",
    "require-dev": {
        "phpstan/phpstan": "^1.0"
    },
    "autoload": {
        "psr-4": {
            "Spaze\\PHPStan\\DisallowedCalls\\": "src/"
        }
    }
}

• name: 项目的名称。
• description: 项目的描述。
• require-dev: 开发依赖，例如 PHPStan。
• autoload: 自动加载配置，定义了命名空间和对应的路径。

通过以上配置，你可以有效地使用 PHPStan Disallowed Calls 扩展来检测和防止在生产代码中使用不允许的函数、方法和常量。

phpstan-disallowed-callsPHPStan rules to detect disallowed method & function calls, constant, namespace, attribute & superglobal usages项目地址:https://gitcode.com/gh_mirrors/ph/phpstan-disallowed-calls