README

• name 参数用于指定 RediSearch 中数据的名称。如果缺失，则使用属性名称，或根据获取器规则（get/is）使用方法名称。
• noStem 参数是一个布尔值，用于指示数据是否应使用词干提取。
• weight 参数是一个浮点数，用于指示数据在结果排序中的权重。
• phonetic 参数是一个字符串，用于指示音韵搜索的语言。
• sortable 参数是一个布尔值，用于指示数据是否可以用于排序结果。
• noIndex 参数是一个布尔值，用于指示数据是否应可搜索。
• unNormalized 参数是一个布尔值，用于指示数据是否应可搜索。

NumericField 映射

@NumericField([name], [sortable], [noIndex], [unNormalized])（或 PHP 8 属性的#[NumericField([name], [sortable], [noIndex], [unNormalized])]）允许你在搜索引擎中添加数字。映射可以设置在属性上，或者设置在无参数的方法上。

• name 参数用于指定 RediSearch 中数据的名称。如果缺失，则使用属性名称，或根据获取器规则（get/is）使用方法名称。
• sortable 参数是一个布尔值，用于指示数据是否可以用于排序结果。
• noIndex 参数是一个布尔值，用于指示数据是否应可搜索。
• unNormalized 参数是一个布尔值，用于指示数据是否应可搜索。

TagField映射

@TagField([name], [separator], [sortable], [noIndex], [unNormalized])（或 PHP 8 属性的#[TagField([name], [separator], [sortable], [noIndex], [unNormalized])]）允许你在搜索引擎中添加文本。映射可以设置在属性上，或者设置在无参数的方法上。

• name 参数用于指定 RediSearch 中数据的名称。如果缺失，则使用属性名称，或根据获取器规则（get/is）使用方法名称。
• separator参数是一个字符串，用于指示用于分隔值的字符。
• sortable 参数是一个布尔值，用于指示数据是否可以用于排序结果。
• noIndex 参数是一个布尔值，用于指示数据是否应可搜索。
• unNormalized 参数是一个布尔值，用于指示数据是否应可搜索。

TagField的数据链接可以是标量数据，或是一个简单的标量数组（一维）。

GeoField映射

@GeoField([name], [noIndex], [sortable], [unNormalized])（或 PHP 8 属性的#[GeoField([name], [noIndex], [sortable], [unNormalized])]）允许你在搜索引擎中添加地理坐标。映射可以设置在属性上，或者设置在无参数的方法上。

• name 参数用于指定 RediSearch 中数据的名称。如果缺失，则使用属性名称，或根据获取器规则（get/is）使用方法名称。
• noIndex 参数是一个布尔值，用于指示数据是否应可搜索。
• unNormalized 参数是一个布尔值，用于指示数据是否应可搜索。

Suggestion映射

@Suggestion([group], [score], [increment], [payload])（或 PHP 8 属性的#[Suggestion([group], [score], [increment], [payload])]）允许你在搜索引擎中添加地理坐标。映射可以设置在属性上，或者设置在无参数的方法上。

• group参数用于指定 RediSearch 中的建议注册表名称。如果缺失，则默认为'suggestion'。
• score参数是一个浮点数，用于指示建议中值的优先级。如果缺失，则分数默认为1.0。
• increment参数是一个布尔值，用于指示当前建议的分数是否应添加到具有相同值的现有建议中。如果缺失，则分数不会添加。
• payload参数是一个字符串，用于向建议添加额外数据（在建议引擎中未使用）。如果缺失，则不会向建议附加任何有效负载。

JSON映射

JSON映射文件可以包含多个类映射。JSON应遵循模式。

[
  {
    "class": "\\MyApp\\Model\\Product",
    "index": "product",
    "stop-words": ["the", "a", "an", "this"],
    "fields": {
      "name": {"property": "name", "type": "text"},
      "manufacturer": {"getter": "getManufacturerName", "type": "text"},
      "price": {"getter": "getFinalPrice", "type": "numeric"},
      "colors": {"property": "colors", "type": "tag", "separator": "|"},
      "manufacturer_address": {"property": "manufacturerAddress", "type": "geo"}
    },
    "suggestions": [
      {"property": "name"},
      {"property": "colors", "group": "color"},
      {"getter": "getManufacturerName"}
    ]
  }
]

要启用JSON映射，必须使用\MacFJA\RediSearch\Integration\Json\JsonProvider。还必须安装JSON PHP扩展。

必须将JSON文件传递给\MacFJA\RediSearch\Integration\Json\JsonProvider::addJson方法。

（JsonProvider可以添加到CompositeProvider）

XML映射

XML映射文件可以包含多个类映射。JSON应遵循XSD模式。

<?xml version="1.0" encoding="UTF-8" ?>
<redis-search xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://github.com/MacFJA/php-redisearch-integration/blob/main/src/Xml/schema.xsd">
    <class name="MyApp\Model\Integration\Product" indexname="product">
        <id type="property">id</id>
        <stops-words>
            <word>the</word>
            <word>a</word>
            <word>an</word>
            <word>this</word>
        </stops-words>
        <fields>
            <text-field>firstname</text-field>
            <text-field getter="getManufacturerName">firstname</text-field>
            <numeric-field getter="getFinalPrice">price</numeric-field>
            <tag-field property="colors" separator="|">color</tag-field>
            <geo-field property="manufacturerAddress">manufacturer_address</geo-field>
        </fields>
        <suggestions>
            <property name="name" />
            <property name="colors" group="color" />
            <getter name="getManufacturerName" />
        </suggestions>
    </class>
</redis-search>

要启用XML映射，必须使用\MacFJA\RediSearch\Integration\Xml\XmlProvider。还必须安装SimpleXML PHP扩展。

必须将XML文件传递给\MacFJA\RediSearch\Integration\Xml\XmlProvider::addXml方法。

（XmlProvider可以添加到CompositeProvider）

接口映射

你可以通过实现\MacFJA\RediSearch\Integration\Mapping接口来创建自己的映射，并将类添加到SimpleProvider中。

（SimpleProvider可以添加到CompositeProvider）

事件

ObjectWorker发出多个事件，允许你更改其行为。

事件分为两个主要组：Before组和After组。在Before组中，你可以在与Redis交互之前更改配置。在After组中，你可以对结果执行更多操作。

Before组

以下参数可以用粗体表示可以更改。

After组

以下参数可以用粗体表示可以更改。

贡献

你可以为库做出贡献。为此，你可以使用 Github issues 来

• 提出你的问题
• 建议新的映射提供者
• 请求任何更改（错别字、不良代码等）
• 等等...

您还可以使用PR来

• 添加新的映射提供者
• 建议更正
• 等等...

更多信息请参阅 CONTRIBUTING。

许可证

MIT许可证（MIT）。更多信息请参阅 许可证文件。