umbraco search extensionsダウンロード - umbraco search extensionsソースコードのダウンロード

umbraco search extensions

その他のソースコード

v3.2.1

ダウンロード

Umbraco 検索拡張機能

はじめる

このパッケージは、Umbraco v9 ～ v13 および v14 でサポートされています。

インストール

検索拡張機能は NuGet 経由で利用できます。

.NET CLI を使用してインストールするには、次のコマンドを実行します。

 $ dotnet add package Our.Umbraco.Extensions.Search

Visual Studio 内からインストールするには、NuGet パッケージマネージャー UI を使用するか、次のコマンドを実行します。

 PM> Install-Package Our.Umbraco.Extensions.Search

使用法

クエリを実行する

インデックス内の Umbraco コンテンツをクエリするための短縮拡張メソッドがいくつかあり、アイテムが公開されているか、表示されているか、またはテンプレートがあるかを確認します。

公開されたコンテンツアイテムのみをクエリするには、次のように実行できます。

 query.And().IsPublished()

同様に、 umbracoNaviHideプロパティが設定されていないすべてのコンテンツをクエリするには、次のように実行できます。

 query.And().IsVisible()

特定のテンプレート ID を設定してコンテンツをクエリすることができます。 0がメソッドに渡されるか、値が渡されない場合、クエリは任意のテンプレート ID セットを持つコンテンツと一致します。

 query.And().HasTemplate(int templateId)

最後に、指定されたコンテンツタイプエイリアスのいずれかを持つコンテンツをクエリすることができます。 Umbraco は、デフォルトで単一のコンテンツエイリアスのクエリをサポートしています。

 query.And().NodeTypeAlias(string[] aliases)

文化

「文化によって異なる」ように設定された Umbraco プロパティは、特定のエイリアス{fieldName}_{culture}でインデックス付けされます。たとえば、「pageTitle」フィールドが文化によって異なり、英語とスペイン語の 2 つの言語がある場合、インデックスにはpageTitle_enとpageTitle_es 2 つのフィールドが含まれます。

カルチャは、次のようにFieldクエリとNodeNameクエリに渡すことができます。

 query.And().Field(string field, string culture)

query.And().NodeName(string nodeName, string culture)

複数のフィールドを指定できるGroupedAnd 、 GroupedOr 、 GroupedNotなどのグループ化されたクエリでも機能します。

 query.And().GroupedOr(string[] fields, string culture)

検索中

Page<T>拡張メソッドは、Examine のISearchResultsから特定の位置( page )にある指定された数のアイテム( perPage )を効率的に取得します。オプションの型制約を追加すると、 IPublishedContentにキャストされたページングされた結果も返すことができます。

 var query = searcher.CreatePublishedQuery();

var searchResults = query.Execute();

var results = searchResults.Page<T>(query, int page, int perPage, out int totalPages, out int totalResults);

ページと結果の合計数はoutパラメータとして公開されますが、必要がない場合は次のように無視できます。

 searchResults.Page<T>(query, int page, int perPage, out _, out _);

結果

次のように、結果コレクション全体を特定の型のリストにキャストできます。

 var results = query.Execute().GetResults<T>();

個々の検索結果の特定のフィールドには、次のように.Value<T>()拡張メソッドを介してアクセスできます。

 foreach (var result in query.Execute())
{
    var value = result.Value<T>(string field);
}

先端分野

Search Extensions は、Umbraco データに正しくインデックスが付けられ、クエリ可能であることを保証するために、いくつかの新しいフィールドタイプ ( json 、 list 、 UDI 、およびpicker ) を Examine に導入します。

Examine では、.NET の名前付きオプションパターンを介して、インデックスのフィールド、フィールドタイプなどを制御できます。

 public class ConfigureIndexOptions : IConfigureNamedOptions<LuceneDirectoryIndexOptions>
{
    public void Configure(string name, LuceneDirectoryIndexOptions options)
    {
        if (name == "ExternalIndex")
        {
            options.FieldDefinitions.AddOrUpdate(new FieldDefinition("fieldName", "fieldType"));
        }
    }
}

オプションクラスを適用するには、Dependency Injection コンテナーに登録する必要があります。

 builder.Services.ConfigureOptions<ConfigureIndexOptions>();

コア分野

Umbraco の「パス」フィールドはリストとして自動的にインデックス付けされるため、パス-1,1050,1100のコンテンツ項目は次のようにクエリできます。

 query.Field("path", "1100");

Umbraco の「createDate」フィールドと「updateDate」フィールドは、通常は文字列値としてインデックスが作成されるのに対し、 date値として自動的にインデックスが作成されます。

ピッカー

pickerフィールドタイプは、選択された項目の検索に適した別名をインデックスに追加します。

「サンプルページ」と呼ばれるコンテンツアイテムが選択されたピッカーは、次のようにクエリできます。

 query.Field("somePicker", "example-page");

JSON

jsonフィールドタイプは、JSON オブジェクトのプロパティをインデックス内の個々のフィールドに分割します。

「locations」というフィールドに次の JSON 値があると想像してください。

 [
    {
        "city": "London",
        "position": {
            "latitude": 51.5074,
            "longitude": 0.1278
        }
    },
    {
        "city": "New York",
        "position": {
            "latitude": 40.7128,
            "longitude": 74.0060
        }
    }
]

各プロパティは、ネストされたプロパティを含め、インデックス内のフィールドとして作成されます。この例では、これらは「locations_city」、「locations_position_latitude」、および「locations_position_longitude」と呼ばれます。

JSON パス形式でパスを指定することで、JSON オブジェクトのプロパティのサブセットにインデックスを付けることができます。

json型を実装するインデックスに新しいValueTypeFactoryを登録し、フィールドに割り当てる前にパスをパラメーターとして定義します。

 public class ConfigureIndexOptions : IConfigureNamedOptions<LuceneDirectoryIndexOptions>
{
    public void Configure(string name, LuceneDirectoryIndexOptions options)
    {
        if (name == "ExternalIndex")
        {
            options.IndexValueTypesFactory = new Dictionary<string, IFieldValueTypeFactory>(options.IndexValueTypesFactory)
            {
                ["position"] = new DelegateFieldValueTypeFactory(fieldName =>
                {
                    return new JsonValueType(fieldName, "$[*].position");
                };
            };

            options.FieldDefinitions.AddOrUpdate(new FieldDefinition("locations", "position"));
        }
    }
}

複数のフィールドタイプ

同じ JSON オブジェクトの異なる部分を個別に名前を付けたフィールドにインデックス付けしたり、JSON オブジェクト内の特定のプロパティを定義されたタイプとしてインデックス付けしたりするなど、複数のフィールドタイプとして値のインデックス付けが必要になる高度なケースがあります。

MultipleValueTypeFactoryは、一連のフィールドタイプをフィールドに割り当て、それらを順番に適用します。

 public class ConfigureIndexOptions : IConfigureNamedOptions<LuceneDirectoryIndexOptions>
{
    public void Configure(string name, LuceneDirectoryIndexOptions options)
    {
        if (name == "ExternalIndex")
        {
            options.IndexValueTypesFactory = new Dictionary<string, IFieldValueTypeFactory>(options.IndexValueTypesFactory)
            {
                ["locationData"] = new DelegateFieldValueTypeFactory(fieldName =>
                {
                    return new MultipleValueTypeFactory(
                        fieldName,
                        new IIndexFieldValueType[]
                        {
                            new JsonValueType(x, "$[*].city"),
                            new JsonValueType("position", "$[*].position")
                        }
                    );
                };
            };

            options.FieldDefinitions.AddOrUpdate(new FieldDefinition("locations", "locationData"));
        }
    }
}

この例では、同じ「場所」JSON オブジェクトにすべての都市が含まれ、すべての緯度と経度を含むまったく新しい「位置」フィールドが作成されます。