unused public

在您的代码中找到未使用的公共元素

很容易找到未使用的私人课程元素，因为它们在班级本身中没有使用。但是，公共方法/属性/常数呢？

 final class Book
 {
     public function getTitle(): string
     {
         // ...
     }

-    public function getSubtitle(): string
-    {
-        // ...
-    }
}

我们如何检测未使用的公共元素？

• 找到公共方法
• 在代码和模板中查找所有公共方法调用
• 如果找不到公共方法，它可能未使用

这正是这个软件包的作用。

该技术对于私人项目非常有用，并且要检测出意外使用的public修饰符，该修饰符应仅按照本地的方式更改为private 。

安装

composer require tomasvotruba/unused-public --dev

该软件包可用于PHP 7.2+版本。

用法

使用PHPSTAN扩展安装程序，一切都可以运行。

用简单的配置自行启用每个项目：

 # phpstan.neon
parameters :
    unused_public :
        methods : true
        properties : true
        constants : true

您有数百种公共方法吗？您没有时间检查它们，但想逐步处理它们？

设置最大允许％配置：

 # phpstan.neon
parameters :
    unused_public :
        methods : 2.5

这意味着允许所有公共方法中最多2.5％的未使用：

• 如果是5％，您将被提醒。
• 如果是1％，它将被耐受地跳过。

您是否要检查不应删除但要转变为private / protected局部方法调用？

 # phpstan.neon
parameters :
    unused_public :
        local_methods : true 

排除模板中调用的方法

某些方法仅在树枝或叶片模板中使用，并且可以作为未使用的误报报告。

{{ book. getTitle () }}

我们如何排除它们？在配置中添加您的树枝或刀片模板目录以排除方法名称：

 # phpstan.neon
parameters :
    unused_public :
        template_paths :
            - templates 

已知限制

在某些情况下，规则报告误报：

• 当仅在模板中使用时，分开小树枝路径时，无法检测到它们

跳过公共方法

开源供应商设计将由项目使用的公共API。元素是否据报道是未使用的，但实际上是被设计为公开使用的？

用@api注释标记类或元素以跳过它：

 final class Book
{
    /**
     * @api
     */
    public function getName ()
    {
        return $ this -> name ;
    }
}