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 是一个用于 PHPStan 的扩展，旨在检测代码中不允许使用的函数、方法、常量、命名空间和超级全局变量的调用。这个扩展可以帮助开发者在代码提交之前发现并修复潜在的安全隐患或不良实践。

项目的主要功能包括：

• 检测不允许使用的函数和方法调用。
• 检测不允许使用的常量和命名空间。
• 检测不允许使用的超级全局变量。
• 支持自定义配置，允许开发者根据项目需求禁用特定的函数或方法。

2. 项目快速启动

安装

首先，确保你已经安装了 PHPStan。然后，使用 Composer 安装 phpstan-disallowed-calls 扩展：

composer require --dev spaze/phpstan-disallowed-calls

配置

在你的 PHPStan 配置文件（通常是 phpstan.neon）中，添加以下配置：

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

示例代码

假设你有一个 PHP 文件 example.php，其中包含以下代码：

<?php

function debug($var) {
    var_dump($var);
}

debug("Hello, World!");

运行 PHPStan 分析：

vendor/bin/phpstan analyse example.php

PHPStan 将会报告 var_dump 函数的使用是不允许的，并建议使用自定义的日志记录器。

3. 应用案例和最佳实践

应用案例

假设你正在开发一个电子商务网站，其中包含敏感的用户数据。为了确保代码的安全性，你决定禁用一些危险的函数，如 var_dump 和 print_r。通过使用 phpstan-disallowed-calls，你可以在代码提交之前自动检测这些函数的使用，并强制开发者使用安全的日志记录器。

最佳实践

1. 自定义禁用列表：根据项目需求，自定义禁用的函数和方法列表。例如，禁用所有与数据库交互的函数，除非它们是通过安全的 ORM 或 DAO 层调用的。
2. 集成到 CI/CD 流程：将 PHPStan 和 phpstan-disallowed-calls 集成到持续集成和持续部署（CI/CD）流程中，确保每次代码提交都经过严格的静态分析。
3. 文档化禁用规则：在项目的文档中明确列出所有禁用的函数和方法，并解释为什么它们被禁用。这有助于新加入的开发者理解项目的代码规范。

4. 典型生态项目

PHPStan

phpstan-disallowed-calls 是 PHPStan 生态系统中的一个重要扩展。PHPStan 是一个静态分析工具，用于在代码运行之前检测潜在的错误和不良实践。通过结合 phpstan-disallowed-calls，你可以进一步提升代码的质量和安全性。

Nette Framework

phpstan-disallowed-calls 还提供了针对 Nette Framework 的特定配置文件。如果你正在使用 Nette Framework，可以轻松地将这个扩展集成到你的项目中，以确保代码符合框架的最佳实践。

其他相关项目

• PHPStan Banned Code：另一个与 phpstan-disallowed-calls 类似的扩展，允许开发者禁用特定的代码模式。
• PHPStan Rules：PHPStan 官方提供的规则集，包含多种静态分析规则，帮助开发者编写更高质量的代码。

通过这些生态项目，你可以构建一个强大的静态分析工具链，确保代码的安全性和可维护性。

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