首頁>編程相關>其他源碼
下載


保險絲

PHP 的模糊搜尋庫

這是很棒的 Fuse.js 專案的 PHP 端口，旨在盡可能提供完整的 API 相容性。

查看他們的演示和範例，以充分了解該庫的功能。

最新相容的 Fuse.js 版本：7.0.0

目錄：

  • 安裝
  • 用法
  • 選項
  • 方法
  • 與 Fuse.js 的差異
  • 發展

安裝

該軟體包可透過 Composer 取得。要將其添加到您的專案中，只需運行： 

composer require loilo/fuse

請注意，使用 Fuse 至少需要 PHP 7.4。

用法

這是一個簡單的使用範例： 

 <?php
require_once ' vendor/autoload.php ' ;

$ list = [
    [
        ' title ' => " Old Man's War " ,
        ' author ' => ' John Scalzi ' ,
    ],
    [
        ' title ' => ' The Lock Artist ' ,
        ' author ' => ' Steve Hamilton ' ,
    ],
    [
        ' title ' => ' HTML5 ' ,
        ' author ' => ' Remy Sharp ' ,
    ],
    [
        ' title ' => ' Right Ho Jeeves ' ,
        ' author ' => ' P.D Woodhouse ' ,
    ],
];

$ options = [
    ' keys ' => [ ' title ' , ' author ' ],
];

$ fuse = new  Fuse  Fuse ( $ list , $ options );

$ fuse -> search ( ' hamil ' );

這會產生以下結果（其中每個結果的item引用匹配的條目本身，並且refIndex提供該項目在原始$list中的位置）： 

[
    [
        ' item ' => [
            ' title ' => ' The Lock Artist ' ,
            ' author ' => ' Steve Hamilton ' ,
        ],
        ' refIndex ' => 1 ,
    ],
    [
        ' item ' => [
            ' title ' => ' HTML5 ' ,
            ' author ' => ' Remy Sharp ' ,
        ],
        ' refIndex ' => 2 ,
    ],
];

選項

Fuse 有很多選項可以優化您的搜尋：

基本選項

isCaseSensitive

  • 類型： bool
  • 預設值： false

指示比較是否應區分大小寫。

includeScore

  • 類型： bool
  • 預設值： false

分數是否應包含在結果集中。 0分錶示完全匹配， 1分錶示完全不匹配。

includeMatches

  • 類型： bool
  • 預設值： false

匹配是否應包含在結果集中。當true時，結果集中的每筆記錄將包含符合字元的索引。因此，這些可以用於突出顯示的目的。

minMatchCharLength

  • 類型： int
  • 預設值： 1

僅傳回長度超過該值的符合項。 （例如，如果您想忽略結果中的單一字元匹配，請將其設為2 ）。

shouldSort

  • 類型： bool
  • 預設值： true

是否按分數對結果清單進行排序。

findAllMatches

  • 類型： bool
  • 預設值： false

當為 true 時，匹配函數將繼續到搜尋模式的末尾，即使已在字串中找到完美匹配。

keys

  • 類型： array
  • 預設: []

將搜尋的鍵列表。這支援嵌套路徑、加權搜尋、字串和物件數組中的搜尋。

模糊匹配選項

location

  • 類型： int
  • 預設值： 0

確定預期在文本中找到的模式的大概位置。

threshold

  • 類型： float
  • 預設值： 0.6

匹配演算法在什麼時候放棄。閾值0.0需要完美匹配（字母和位置），閾值1.0可以匹配任何內容。

distance

  • 類型： int
  • 預設值： 100

決定匹配與模糊位置（由location指定）的接近程度。與模糊位置distance字元較遠的精確字母匹配將被評分為完全不匹配。 distance 0要求符合位於指定的精確location 。距離1000需要使用threshold 0.8找到location的800字元以內的完美匹配。

ignoreLocation

  • 類型： bool
  • 預設值： false

當true時，搜尋將忽略location和distance ，因此模式出現在字串中的位置並不重要。

提示：預設選項僅搜尋前 60 個字元。如果合理預期匹配在此範圍內，則這應該足夠了。若要修改此行為，請設定location 、 threshold 、 distance （或ignoreLocation ）的適當組合。

為了更了解這些選項如何協同工作，請閱讀 Fuse.js 的評分理論。

進階選項

useExtendedSearch

  • 類型： bool
  • 預設值： false

當true時，它允許使用類 UNIX 搜尋命令。參見範例。

getFn

  • 類型： callable
  • 預設：來源

用於在提供的路徑中檢索物件值的函數。預設情況下也會搜尋嵌套路徑。

sortFn

  • 類型： callable
  • 預設：來源

用於對所有結果進行排序的函數。預設將依相關性分數升序、索引升序排序。

ignoreFieldNorm

  • 類型： bool
  • 預設值： false

當true時，相關性分數（用於排序）的計算將忽略欄位長度範數。

提示：將ignoreFieldNorm設為true唯一有意義的情況是，無論有多少個術語，只要查詢術語存在即可。

fieldNormWeight

  • 類型： float
  • 預設值： 1

決定欄位長度範數對評分的影響程度。值0相當於忽略字段長度範數。值為0.5將大大降低字段長度範數的影響，而值為2.0將大大增加它。

全域配置

您可以透過config方法存取和操作上述所有選項的預設值： 

 // Get an associative array of all options listed above
Fuse :: config ();

// Merge associative array of options into default config
Fuse :: config ([ ' shouldSort ' => false ]);

// Get single default option
Fuse :: config ( ' shouldSort ' );

// Set single default option
Fuse :: config ( ' shouldSort ' , false );

方法

每個FuseFuse實例都可以使用下列方法：

search

搜尋整個文件集合，並傳回搜尋結果清單。 

 public function search( mixed $ pattern , ? array $ options ): array

$pattern可以是以下之一：

  • 細繩
  • 小路
  • 擴充查詢
  • 邏輯查詢

$options ：

  • limit (type: int )：表示傳回搜尋結果的最大數量。

setCollection

設定/取代整個文件集合。如果未提供索引，則會產生一個。 

 public function setCollection( array $ docs , ?  Fuse  Core  FuseIndex $ index ): void

例子： 

 $ fruits = [ ' apple ' , ' orange ' ];
$ fuse = new Fuse ( $ fruits );

$ fuse -> setCollection ([ ' banana ' , ' pear ' ]);

add

將文件新增至集合並相應地更新索引。 

 public function add( mixed $ doc ): void

例子： 

 $ fruits = [ ' apple ' , ' orange ' ];
$ fuse = new Fuse ( $ fruits );

$ fuse -> add ( ' banana ' );

sizeof ( $ fruits ); // => 3

remove

從清單中刪除謂詞傳回 true 的所有文檔，並傳回已刪除文檔的陣列。使用兩個參數呼叫謂詞： ($doc, $index) 。 

 public function remove(? callable $ predicate ): array

例子： 

 $ fruits = [ ' apple ' , ' orange ' , ' banana ' , ' pear ' ];
$ fuse = new Fuse ( $ fruits );

$ results = $ fuse -> remove (fn( $ doc ) => $ doc === ' banana ' || $ doc === ' pear ' );
sizeof ( $ fuse -> getCollection ()); // => 2
$ results ; // => ['banana', 'pear']

removeAt

刪除指定索引處的文件。 

 public function removeAt( int $ index ): void

例子： 

 $ fruits = [ ' apple ' , ' orange ' , ' banana ' , ' pear ' ];
$ fuse = new Fuse ( $ fruits );

$ fuse -> removeAt ( 1 );

$ fuse -> getCollection (); // => ['apple', 'banana', 'pear']

getIndex

傳回產生的 Fuse 索引。 

 public function getIndex():  Fuse  Core  FuseIndex

例子： 

 $ fruits = [ ' apple ' , ' orange ' , ' banana ' , ' pear ' ];
$ fuse = new Fuse ( $ fruits );

$ fuse -> getIndex ()-> size (); // => 4

索引

每個FuseFuse實例都可以使用下列方法：

Fuse::createIndex

從清單中預先產生索引，並將其直接傳遞到 Fuse 實例中。如果列表（相當）大，它會加快實例化速度。 

 public static function createIndex( array $ keys , array $ docs , array $ options = []):  Fuse  Core  FuseIndex

例子： 

 $ list = [ ... ]; // See the example from the 'Usage' section
$ options = [ ' keys ' => [ ' title ' , ' author.firstName ' ] ];

// Create the Fuse index
$ myIndex = Fuse :: createIndex ( $ options [ ' keys ' ], $ list );

// Initialize Fuse with the index
$ fuse = new Fuse ( $ list , $ options , $ myIndex );

Fuse::parseIndex

解析 JSON 序列化的 Fuse 索引。 

 public static function parseIndex( array $ data , array $ options = []):  Fuse  Core  FuseIndex

例子： 

 // (1) When the data is collected

$ list = [ ... ]; // See the example from the 'Usage' section
$ options = [ ' keys ' => [ ' title ' , ' author.firstName ' ] ];

// Create the Fuse index
$ myIndex = Fuse :: createIndex ( $ options [ ' keys ' ], $ list );

// Serialize and save it
file_put_contents ( ' fuse-index.json ' , json_encode ( $ myIndex ));


// (2) When the search is needed

// Load and deserialize index to an array
$ fuseIndex = json_decode ( file_get_contents ( ' fuse-index.json ' ), true );
$ myIndex = Fuse :: parseIndex ( $ fuseIndex );

// Initialize Fuse with the index
$ fuse = new Fuse ( $ list , $ options , $ myIndex );

與 Fuse.js 的差異

Fuse.js PHP熔斷器
取得保險絲版本Fuse.version –
存取全域配置Fuse.config屬性Fuse::config方法
清單修改使用fuse.add()等修改傳遞給new Fuse建構子的原始列表。在 PHP 中，陣列是一種原始資料類型，這表示 Fuse 永遠不會修改您的原始清單。若要在新增/刪除項目後接收目前列表，可以使用$fuse->getCollection()方法。

發展

專案範圍

請注意，我正在努力實現與 Fuse.js 的功能對等，因此不會為 Fuse.js 本身未反映的搜尋邏輯添加功能或修復。

如果您對搜尋結果有任何問題，但這些問題在這個 PHP 端口中並不是明顯的錯誤，並且您碰巧了解JavaScript，請檢查您的用例是否在Fuse.js 的線上演示中正常工作，因為這是規範的Fuse 實作。如果問題也出現在那裡，請在他們的儲存庫中開啟一個問題。

設定

要開始在 Fuse 上進行開發，您需要 git、PHP (≥ 7.4) 和 Composer。

由於程式碼是使用 Prettier 格式化的，因此也建議安裝 Node.js/npm 以及使用支援 Prettier 格式化的編輯器。

克隆存儲庫並cd到其中： 

git clone https://github.com/loilo/fuse.git
cd fuse

安裝 Composer 依賴項： 

composer install

安裝 npm 依賴項（可選但建議）。這僅在程式碼格式化時需要，因為 npm 依賴項包括該專案使用的 Prettier 插件。 

 npm ci

品質保證

該項目有不同類型的程式碼檢查。所有這些都在提交拉取請求時運行，但也可以在本地運行：

命令目的描述
vendor/bin/phpcs檢查程式碼風格執行 PHP_CodeSniffer 以驗證 Fuse 原始碼是否遵循 PSR-12 編碼樣式。
vendor/bin/psalm靜態分析針對程式碼庫執行 Psalm 以避免與類型相關的錯誤和不安全的編碼模式。
vendor/bin/phpunit檢查程序邏輯從test資料夾執行所有 PHPUnit 測試。

貢獻

在提交拉取請求之前，請將相關測試新增至test資料夾。

展開
附加信息
相關應用
爲您推薦
相關資訊 全部