kirby fuzzy searchダウンロード - kirby fuzzy searchソースコードダウンロード

kirby fuzzy search

その他のソースコード

1.0.0

ダウンロード

カービィあいまい検索（ベータ版）

カービィのあいまい検索プラグイン。コンテンツ内の検索クエリのおおよその一致を探すのが、かつてないほど簡単になりました。

これは、fuzzget PHP ライブラリ上に構築されたプラグインです。

基本的な使い方

すでに Kirby 組み込みsearchメソッドを使用している場合は、ページコレクションのメソッドの名前を変更するだけで、それをファジー検索に置き換えることができます。

$query    = get('q');
$articles = page('blog')
    ->children()
    ->visible()
-   ->search($query, 'title|text');
+   ->fuzzySearch($query, 'title|text');

あいまい検索は、カービィsearch方法で利用できる他のオプションとは互換性がありません。

あいまい検索を使用すると、カスタムページメソッドまたはページモデルを通じて検索することもできます。 fuzzySearch最後のパラメータにメソッド名を含める必要があるだけです。

 // site/plugins/methods.php
page:: $ methods [ ' authorName ' ] = function ( $ page ) {
    $ author = $ page -> author ()-> value ();

    if ( $ user = site ()-> user ( $ author )) {
        return $ user -> firstname (). ' ' . $ user -> lastname ();
    }
};

 $ query    = get ( ' q ' );
$ articles = page ( ' blog ' )
    -> children ()
    -> visible ()
    -> fuzzySearch ( $ query , ' title|text|authorName ' );

構造化フィールドの検索

ファジー検索には、構造化フィールドなどのデータセットを含むページフィールドを検索できる便利なフィールドメソッドが付属しています。

 $ result = page ( ' faq ' )
    -> topics ()
    -> fuzzySearch ( $ query , ' question|answer ' );

$result単なる配列ではなく、 Fieldオブジェクトでもあります。こうすることで、検索を行った後に、 toStructure 、 yaml 、 isEmptyなどの任意のFieldメソッドを自由にチェーンできます。

 $ result = page ( ' contact ' )
    -> addresses ()
    -> fuzzySearch ( $ query , ' city ' )
    -> toStructure ();

配列の検索

fuzzySearch関数を使用して、連想配列の配列を検索することもできます。

 $ countries = [
    [ ' name ' => ' Australia ' ],
    [ ' name ' => ' Brazil ' ],
    [ ' name ' => ' Canada ' ],
    [ ' name ' => ' France ' ],
    [ ' name ' => ' Germany ' ],
    [ ' name ' => ' Portugal ' ],
    [ ' name ' => ' United Kingdom ' ],
    [ ' name ' => ' United States ' ]
];

$ results = fuzzySearch ( $ countries , ' Brasil ' );

高度な使用法

最後のパラメータを省略すると、あいまい検索は指定されたデータ内のすべてのキー (フィールド) を検索します。

 site ()-> index ()-> fuzzySearch ( $ query );

*ワイルドカードを使用するのと同じです。

 site ()-> index ()-> fuzzySearch ( $ query , ' * ' );

ファジー検索は、一致を検索するフィールドを選択する際に非常に柔軟です。他のオプションを確認してください。

含む

titleとtextフィールドのみで特定の用語を検索する場合は、その名前を|で区切った最後のパラメータに渡すだけです。 :

 site ()-> index ()-> fuzzySearch ( $ query , ' title|text ' );

それは次のような構文シュガーです。

 site ()-> index ()-> fuzzySearch ( $ query , [
    ' include ' => [ ' title ' , ' text ' ]
]);

無視する

もちろん、検索したくないフィールドをリストすることもできます。

 site ()-> index ()-> fuzzySearch ( $ query , ' -author|-date ' );

上記は次のことを行うのと同じです。

 site ()-> index ()-> fuzzySearch ( $ query , [
    ' ignore ' => [ ' author ' , ' date ' ]
]);

この例では、 authorとdateを除くすべてのフィールドが検索の対象となります。

カスタムページメソッドまたはページモデルメソッドを含める必要がある場合は、ワイルドカードと組み合わせて構文を無視できます。

 site ()-> index ()-> fuzzySearch ( $ query , ' *|authorName|-date ' );

上記には、カスタムページメソッドまたはページモデルメソッドの場合に備えて、 dateと$page->authorName()を除くすべてのフィールドが含まれます。

インストール

要件

カービィ 2.3.2+
PHP 7.0+

ダウンロード

ファイルをダウンロードして、 site/plugins/fuzzy-search内に配置します。

カービィCLI

Kirby のコマンドラインインターフェイスを使用すると、あいまい検索プラグインのインストールが簡単になります。

 $ kirby plugin:install pedroborges/kirby-fuzzy-search

更新はこれ以上に簡単です。単に実行するだけです。

 $ kirby plugin:update pedroborges/kirby-fuzzy-search

Gitサブモジュール

Fuzzy Search プラグインを Git サブモジュールとして追加できます。

 $ cd your/project/root
$ git submodule add https://github.com/pedroborges/kirby-fuzzy-search.git site/plugins/fuzzy-search
$ git submodule update --init --recursive
$ git commit -am "Add Fuzzy Search plugin"

更新はいくつかのコマンドを実行するだけで簡単です。

 $ cd your/project/root
$ git submodule foreach git checkout master
$ git submodule foreach git pull
$ git commit -am "Update submodules"
$ git submodule update --init --recursive