unused public

ابحث عن العناصر العامة غير المستخدمة في الكود الخاص بك

من السهل العثور على عناصر فئة خاصة غير مستخدمة ، لأنها غير مستخدمة في الفصل نفسه. ولكن ماذا عن الأساليب العامة/الخصائص/الثوابت؟

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

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

كيف يمكننا اكتشاف العنصر العام غير المستخدم؟

• ابحث عن طريقة عامة
• ابحث عن جميع مكالمات الطريقة العامة في الكود والقوالب
• إذا لم يتم العثور على الطريقة العامة ، فربما غير مستخدمة

هذا بالضبط ما تفعله هذه الحزمة.

هذه التقنية مفيدة للغاية للمشاريع الخاصة واكتشاف المعدل public المستخدم عن طريق الخطأ الذي يجب تغييره إلى private كما يسمى محليًا فقط.

ثَبَّتَ

composer require tomasvotruba/unused-public --dev

الحزمة متاحة لإصدار 7.2+ php.

الاستخدام

مع تثبيت امتداد 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 () }}

كيف يمكننا استبعادهم؟ أضف أدلة Twig أو Blade قالب في التكوين لاستبعاد أسماء الأساليب:

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

القيود المعروفة

في بعض الحالات ، أبلغت القواعد عن إيجابيات كاذبة:

• عند استخدامها فقط في القوالب ، على مسارات الغصين ، لا يمكن اكتشافها

تخطي أساليب عامة فقط

تصميم البائعين المفتوحين تصميم واجهة برمجة التطبيقات العامة لاستخدامها من قبل المشاريع. هل تم الإبلاغ عن العنصر على أنه غير مستخدم ، ولكنه مصمم فعليًا ليتم استخدامه للجمهور؟

حدد الفصل أو العنصر مع @api annotation لتخطيه:

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