LiipSearchBundleダウンロード - LiipSearchBundleソースコードのダウンロード

LiipSearchBundle

その他のソースコード

2.0.0

ダウンロード

Liip検索バンドル

このバンドルは、さまざまな検索エンジンを使用した全文検索のための統一インターフェイスと、検索フォームと結果をレンダリングするための twig テンプレートを備えたコントローラーを提供します。

注: このバンドルのバージョン 2 を参照していますが、バージョン 1 と比較して大きな変更が加えられています。

導入

この検索バンドルを使用すると、サイトへの検索の追加が簡単になります。

提供されるものは次のとおりです。

小枝テンプレートを使用して検索ボックスと検索ページをレンダリングするコントローラー
Googleサイト検索をクエリするサービス
検索結果のページングを提供するサービス

内蔵検索エンジンのサポート

現時点では、Google サイト検索はそのままサポートされています。 Google REST API を使用する実装が 1 つと、フロントエンドで JavaScript のみを使用して検索を読み込むカスタム検索要素機能を使用する実装が 1 つあります。

他のサービスへの貢献も歓迎します。

インストール

composer require liip/search-bundleを使用してバンドルをインストールします。

バンドルを app/Kernel.php に含めます。

好みの検索エンジンを app/config/config.yml に追加します。

 liip_search :
    clients :
        google_rest :
            api_key : ' %google.api_key% '
            search_key : ' %google.search_key% '

または、JavaScript の Google カスタム検索エンジンを使用している場合:

 liip_search :
    clients :
        google_cse :
            cse_id : ' %google.search_key% '

使用法

liip_search_box twig 関数を使用すると、ページ上の任意の場所に検索ボックスを表示できます。

{{ liip_search_box(query, 'query-field-id', 'css-class') }}

次のパラメータを使用して検索ボックスをカスタマイズできます。

クエリ - 表示するデフォルトのクエリ
fieldId - 検索入力フィールドに使用する HTML ID。ページ上 (ヘッダーとコンテンツなど) に複数の検索ボックスがある場合は、異なる ID を使用してください。
cssClass - 検索ボックス<form>全体に適用する CSS クラス。

検索アクションのルートを作成します。最も簡単なのは、メインプロジェクトの routing.xml から提供されている routing.xml を使用することです。

    liip_search:
        resource: "@LiipSearchBundle/Resources/config/routing.xml"

デフォルトは URL /searchです。別のルートが必要な場合は、ルートを含めるときにprefixオプションを使用するか、 _controllerのデフォルト値として%liip_search.controller.search_action%使用して独自のルートを構成します。

テンプレートのカスタマイズ

このバンドルによって提供される検索結果テンプレートは、 LiipSearchBundle::layout.html.twigテンプレートを拡張します。サイトの残りの部分と統合するには、次の 2 つのオプションがあります。

app/Resources/LiipSearchBundle/views/layout.html.twigを作成し、基本レイアウトを拡張して、検索結果が必要な場所にliip_search_contentブロックを配置します。
app/Resources/LiipSearchBundle/views/Search/search.html.twigを作成し、独自のテンプレート構造を構築しますsearch_results.twig.htmlテンプレートをuse liip_search_contentブロックを取得できるはずです。

もちろん、テンプレートをオーバーライドして、テンプレートの動作をカスタマイズすることもできます。 http://symfony.com/doc/master/book/templates.html#overriding-bundle-templates を参照してください。

構成リファレンス

これは、 liip_searchキーで設定できる内容の完全なリファレンスです。

search_factory

文字列、デフォルト値: null

LiipSearchBundleSearchFactoryInterfaceを実装するカスタムサービスを指定します。このサービスは、検索を処理するためのPagerfantaインスタンスを作成するためにコントローラーによって使用されます。

検索エンジンサービスのいずれかを設定する場合、このフィールドを設定する必要はありません。

search_route

文字列、デフォルト値: liip_search

送信された検索リクエストを処理するルートの名前。

restrict_language

ブール値、デフォルト値: false

検索サービスに結果をリクエストの言語に制限するように依頼する場合は、これを true に変更します。

Google 検索 REST API の統合

これらのオプションのいずれかを設定すると、Google 検索エンジンサービスが有効になります。これらはclients.google_restの下にあります。

api_key

文字列、必須

Google API キー

search_key

文字列|配列、必須

Google 検索エンジンを識別するキー。ロケールごとに異なるエンジンを使用するために、ロケールごとにインデックスが付けられたキーのリストである場合があります。別の検索エンジンを通じてロケールを制御する場合、カスタム検索エンジンに追加の言語制限を適用しない限り、 restrict_language true に設定する必要はありません。

api_url

文字列、デフォルト値: https://www.googleapis.com/customsearch/v1

REST 呼び出し用の Google Search API URL

restrict_to_site

文字列、デフォルト値: null

空のままにすると、Google 検索エンジン用に設定されたすべてのサイトが検索されます。 aa ドメインに設定すると、そのドメインに制限されます。

Google カスタム検索エンジンの統合

このセクションを構成すると、JavaScript フラグメントをレンダリングして CSE 検索を有効にする別のコントローラーがアクティブになります。この構成はclients.google_cseの下にあります。

cse_id

文字列|配列、必須

Google カスタム検索エンジンを識別するキー。ロケールごとに異なるエンジンを使用するために、ロケールごとにインデックスが付けられたキーのリストである場合があります。 CSE は、 restrict_languageをサポートしていないため、言語ごとに異なる検索エンジンを使用することが、検索結果の言語を制限する唯一のオプションです。