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