\SearchWP\Attribute
\SearchWP\Attribute は、\SearchWP\Source を構成する個々の部分をモデル化する役割を担います。例:
- エントリータイトル
- エントリーコンテンツ
- エントリースラッグ
- カスタムフィールド
- など…
引数
新しい \SearchWP\Attribute をインスタンス化する際に、以下のいずれか array を提供できます:
name(string)- 一意の名前。(デフォルト:
'') label(string)- 表示ラベル。(デフォルト:
nameの値) default(false|integer)- この
\SearchWP\Attributeをデフォルトで有効にする場合はintを返します。(デフォルト:false) options(array|callable)- 提供される場合、この
\SearchWP\Attributeの複数のインスタンスが考慮されます。例:meta_keyを持つカスタムフィールド。(デフォルト:[]) allow_custom(boolean)- ユーザー定義の
optionを追加できるかどうか。(デフォルト:false) phrases(boolean|array)- この
\SearchWP\Attributeが フレーズベースの検索 をサポートするかどうか。(デフォルト:false) arrayの場合、以下の配列キーが適用されます:table(string) データベーステーブル名。column(string) フレーズと一致させるデータベーステーブルの列。id(string) エントリーIDを追跡するデータベーステーブルの列。data(mixed)- この
\SearchWP\Attributeのデータ。(デフォルト:null) callableの場合、以下の引数が渡されます:id(string)\SearchWP\SourceID。chosen_option(string) 該当する場合、選択された\SearchWP\Attributeoption。
メソッド
\SearchWP\Attribute を扱う際には、考慮すべきいくつかのメソッドがあります。
get_name()- 名前のゲッター。
get_label( $source )- ラベルのゲッター。
\SearchWP\Sourceが提供されている場合、searchwp\source\attribute\labelフィルターが適用されます。 get_phrases()- フレーズサポート引数の値のゲッター。
options_static()optionsが静的であるかどうか(callableとは対照的)。get_options()optionsのゲッター。get_settings()- 設定のゲッター(つまり、
\SearchWP\Engineによって考慮されるもの)。 get_default()defaultのゲッター。set_settings()(integer|array $settings)- 設定のセッター(つまり、
\SearchWP\Engineによって考慮されるもの)。optionsがない場合はintegerを使用し、それ以外の場合は各オプションのキーと対応するinteger値を持つarrayを使用します。 get_data()( $id, $option = '', $raw = false )dataのゲッター。$id(string)\SearchWP\SourceID。$option(string)適用可能な場合のoption値。$raw(boolean)生のデータを返すかどうか。デフォルトはトークン化です。
フック
\SearchWP\Attributeの動作をさらに変更するために、いくつかのフックが利用可能です:

