phan下載 - phan原始碼下載

phan

其他類別

Release 5.4.5 supporting PHP 7.0-8.2 syntax

下載

Phan 是 PHP 的靜態分析器，它更願意最大限度地減少誤報。潘試圖證明錯誤而不是正確。

Phan 尋找常見問題，並在類型資訊可用或可以推斷時驗證各種操作的類型相容性。 Phan 對流量控制有很好的（但不全面）理解，並且可以追蹤一些用例中的值（例如陣列、整數和字串）。

建置狀態

入門

使用 Phan 最簡單的方法是透過 Composer。

 composer require phan/phan

安裝 Phan 後，您需要在專案中建立一個.phan/config.php檔案來告訴 Phan 如何分析原始程式碼。配置完成後，您可以透過./vendor/bin/phan運行它。

Phan 5 依賴具有 php-ast 擴充功能的 PHP 7.2+（首選 1.1.1+），並支援分析 PHP 7.0-8.2 版本語法。可以在此處找到 php-ast 的安裝說明。（Phan 可以在沒有 php-ast 的情況下使用 CLI 選項--allow-polyfill-parser ，但在解析文件註解時略有不同）

替代安裝方法
請參閱入門以了解使用 Phan 的替代方法以及有關如何為專案配置 Phan 的詳細資訊。
逐步加強分析
查看增量加強分析，了解一些關於如何隨著程式碼變得更適合分析而慢慢提高分析的嚴格性的技巧。
安裝依賴項
請查看安裝 Phan 依賴項，以取得在系統上安裝 Phan 依賴項的協助。

Wiki 有更多關於使用 Phan 的資訊。

特徵

Phan 能夠執行以下類型的分析：

檢查所有方法、函數、類別、特徵、介面、常數、屬性和變數是否已定義且可存取。
檢查方法/函數/閉包呼叫的類型安全性和數量問題。
檢查 PHP8/PHP7/PHP5 向後相容性。
檢查舊版 PHP 7.x 次要版本中不支援的功能（例如object 、 void 、 iterable 、 ?T 、 [$x] = ...; 、負字串偏移量、多個異常捕獲等）
檢查數組存取是否健全。
檢查二元運算的類型安全性。
檢查方法、函數和閉包的有效且類型安全的回傳值。
檢查陣列、閉包、常數、屬性、變數、一元運算子和二元運算子上的無操作。
檢查是否有未使用/無效/無法存取的代碼。（傳入--dead-code-detection ）
檢查未使用的變數和參數。（傳入--unused-variable-detection ）
檢查冗餘或不可能的條件以及無意義的轉換。（傳入--redundant-condition-detection ）
檢查未使用的use語句。這些問題和其他一些問題類型可以使用--automatic-fix自動修復。
檢查是否重新定義了類別、函數和方法。
檢查類別繼承的健全性（例如檢查方法簽章相容性）。 Phan 還檢查最終類別/方法是否已重寫、抽象方法是否已實作以及實作的介面是否確實是一個介面（等等）。
支援命名空間、特徵和變數。
支援聯合類型。
支援通用類型（即@template ）。
支援通用數組，例如int[] 、 UserObject[] 、 array<int,UserObject>等。
支援陣列形狀，例如array{key:string,otherKey:?stdClass}等（內部和 PHPDoc 標籤中）這也支援透過array{requiredKey:string,optionalKey?:string}指示陣列形狀的欄位是可選的（對於@param有用）
支援phpdoc類型註解。
支援繼承phpdoc類型註解。
支援檢查 phpdoc 類型註解是否為真實類型簽名的縮小形式（例如子類別/子類型）
支援從 if 元素/迴圈中的 assert() 語句和條件推斷類型。
支援@deprecated註解來棄用類別、方法和函數
支援元素（例如常數、函數、類別、類別常數、屬性或方法）的@internal註解作為定義它的套件的內部元素。
支援@suppress <ISSUE_TYPE>註解來抑制問題。
支援神奇的 @property註解（ @property <union_type> <variable_name> ）
支援神奇的@method註解（ @method <union_type> <method_name>(<union_type> <param1_name>) ）
支援class_alias註釋（實驗性的，預設關閉）
支援透過@phan-closure-scope指示閉包將綁定到的類別（範例）
支援分析傳遞給array_map 、 array_filter和其他內部陣列函數的閉包和傳回類型。
提供廣泛的配置來削弱分析，使其在大型草率程式碼庫中發揮作用
可以在多個核心上運行。（需要pcntl ）
輸出以文字、checkstyle、json、pylint、csv 或 codeclimate 格式發出。
可以在原始程式碼上運行使用者插件以檢查特定於您的程式碼。 Phan 包含您可能想要為您的專案啟用的各種外掛程式。

請參閱 Phan 問題類型，以了解 Phan 可以偵測到的所有問題的描述和範例。查看 PhanIssue 以查看每種錯誤類型的定義。

查看分析大型草率程式碼庫的教學課程，了解持續分析的過程對您來說可能是什麼樣的。

Phan 可以透過語言伺服器協定在各種編輯器和 IDE 中使用，以進行錯誤檢查、「轉到定義」支援等。編輯器和工具還可以使用更簡單的守護程序模式請求對專案中的各個文件進行分析。

有關各種檢查的一些範例，請參閱測試目錄。

Phan 並不完美，不應該用來證明您的基於 PHP 的火箭導引系統沒有缺陷。

插件提供的功能

插件提供了額外的分析功能。

檢查語法上無法存取的語句（例如{ throw new Exception("Message"); return $value; } ）
根據提供的參數檢查*printf()格式字串（以及檢查常見錯誤）
檢查傳遞給preg_*()的 PCRE 正規表示式是否有效
檢查不再需要的@suppress註釋。
檢查重複或遺失的陣列鍵。
檢查編碼風格約定
其他的

範例：Phan 的自我分析外掛程式。

用法

安裝 Phan 後，Phan 需要配置有關在哪裡查找要分析的程式碼以及如何分析程式碼的詳細資訊。告訴 Phan 在哪裡可以找到原始程式碼最簡單的方法是建立一個.phan/config.php檔案。一個簡單的.phan/config.php檔案可能如下所示。

 <?php

/ * *
 * This configuration will be read and overlaid on top of the
 * default configuration . Command line arguments will be applied
 * after this file is read .
 * /
return [

    // Supported values : `'5.6'` , `'7.0'` , `'7.1'` , `'7.2'` , `'7.3'` , `'7.4'` ,
    // `'8.0'` , `'8.1'` , `'8.2'` , `'8.3'` , `null` .
    // If this is set to `null` ,
    // then Phan assumes the PHP version which is closest to the minor version
    // of the php executable used to execute Phan .
    " target_php_version " => null ,

    // A list of directories that should be parsed for class and
    // method information . After excluding the directories
    // defined in exclude_analysis_directory_list , the remaining
    // files will be statically analyzed for errors .
    //
    // Thus , both first - party and third - party code being used by
    // your application should be included in this list .
    ' directory_list ' => [
        ' src ' ,
        ' vendor/symfony/console ' ,
    ],

    // A directory list that defines files that will be excluded
    // from static analysis , but whose class and method
    // information should be included .
    //
    // Generally , you ' ll want to include the directories for
    // third - party code ( such as "vendor/" ) in this list .
    //
    // n . b .: If you ' d like to parse but not analyze 3 rd
    //       party code , directories containing that code
    //       should be added to the `directory_list` as
    //       to `exclude_analysis_directory_list` .
    " exclude_analysis_directory_list " => [
        ' vendor/ '
    ],

    // A list of plugin files to execute .
    // Plugins which are bundled with Phan can be added here by providing their name
    // ( e . g . 'AlwaysReturnPlugin' )
    //
    // Documentation about available bundled plugins can be found
    // at https : // github . com / phan / phan / tree / v5 / . phan / plugins
    //
    // Alternately , you can pass in the full path to a PHP file
    // with the plugin ' s implementation .
    // ( e . g . 'vendor/phan/phan/.phan/plugins/AlwaysReturnPlugin.php' )
    ' plugins ' => [
        // checks if a function , closure or method unconditionally returns .
        // can also be written as 'vendor/phan/phan/.phan/plugins/AlwaysReturnPlugin.php'
        ' AlwaysReturnPlugin ' ,
        ' DollarDollarPlugin ' ,
        ' DuplicateArrayKeyPlugin ' ,
        ' DuplicateExpressionPlugin ' ,
        ' PregRegexCheckerPlugin ' ,
        ' PrintfCheckerPlugin ' ,
        ' SleepCheckerPlugin ' ,
        // Checks for syntactically unreachable statements in
        // the global scope or function bodies .
        ' UnreachableCodePlugin ' ,
        ' UseReturnValuePlugin ' ,
        ' EmptyStatementListPlugin ' ,
        ' LoopVariableReusePlugin ' ,
    ],
];

有關更多詳細信息，請參閱建立設定檔和增量強化分析。

運行phan --help將顯示使用資訊和命令列選項。

註解你的原始碼

Phan 可以閱讀並理解大多數 PHPDoc 類型註釋，包括聯合類型（如int|MyClass|string|null ）和通用數組類型（如int[]或string[]|MyClass[]或array<int,MyClass> ）。

請查看註釋原始程式碼和關於聯合類型，以取得在程式碼中定義類型的一些協助。

Phan 支援(int|string)[]樣式註釋，並在內部將它們表示為int[]|string[] （這兩個註釋都被視為可能包含整數和/或字串的陣列）。當您有混合類型的陣列時，只需使用array 。

以下程式碼顯示了支援的各種註解。

 / * *
 * @ return void
 * /
function f () {}

/ * * @ deprecated * /
class C {
    / * * @ var int * /
    const C = 42 ;

    / * * @ var string [] | null * /
    public $ p = null ;

    / * *
     * @ param int | null $ p
     * @ return string [] | null
     * /
    public static function f ( $ p ) {
        if ( is_null ( $ p )) {
            return null ;
        }

        return array_map (
            / * * @ param int $ i * /
            function ( $ i ) {
                return " thing $ i " ;
            },
            range ( 0 , $ p )
        );
    }
}

就像在 PHP 中一樣，任何類型都可以在函數宣告中為 null，這也表示允許為該參數傳入 null。

Phan 檢查陣列每個元素的類型（包括鍵和值）。實際上，這意味著[$int1=>$int2,$int3=>$int4,$int5=>$str6]被視為array<int,int|string> ， Phan 表示為array<int,int>|array<int,string> 。 [$strKey => new MyClass(), $strKey2 => $unknown]將表示為array<string,MyClass>|array<string,mixed> 。

諸如[12,'myString']之類的文字將在內部表示為數組形狀，如array{0:12,1:'myString'}

產生文件列表

此靜態分析器不會追蹤包含或嘗試找出自動載入器的魔力。它將您扔給它的所有文件視為一個大應用程式。對於封裝在類別中的程式碼來說，這很有效。對於在全域範圍內運行的程式碼，它會變得有點棘手，因為順序很重要。如果您有一個index.php其中包含一個設定一堆全域變數的文件，然後您嘗試在index.php中的include(...)之後存取這些變量，則靜態分析器將不會了解這些變數。

實際上，這只是意味著您應該將入口點和全域範圍內的任何檔案設定放在檔案清單的頂部。如果您有一個config.php設定其他所有需要的全域變量，那麼您應該將其放在列表中的第一個，然後是各種入口點，然後是包含類別的所有庫檔案。