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 ;
    }
}