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 () }}

เราจะยกเว้นพวกเขาได้อย่างไร? เพิ่มไดเรกทอรี twig หรือใบมีดของคุณในการกำหนดค่าเพื่อยกเว้นชื่อวิธี:

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

ข้อ จำกัด ที่รู้จัก

ในบางกรณีกฎรายงานผลบวกปลอม:

• เมื่อใช้ในเทมเพลตเท่านั้นให้แยกเส้นทางทวิกมันเป็นไปไม่ได้ที่จะตรวจจับได้

ข้ามวิธีการสาธารณะเท่านั้น

ผู้ขายโอเพนซอร์ซออกแบบ API สาธารณะที่จะใช้โดยโครงการ องค์ประกอบถูกรายงานว่าไม่ได้ใช้ แต่จริง ๆ แล้วมันถูกออกแบบมาเพื่อใช้งานสาธารณะหรือไม่?

ทำเครื่องหมายคลาสหรือองค์ประกอบด้วยคำอธิบายประกอบ @api เพื่อข้ามไป:

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