`\SearchWP\Attribute`

Table des matières

\SearchWP\Attribute responsable de la modélisation des parties individuelles qui composent un \SearchWP\Source. Par exemple :

Arguments

Lors de l'instanciation d'un nouvel \SearchWP\Attribute, un array des éléments suivants peut être fourni :

name (string): Un nom unique. (défaut : '')
label (string): Libellé d'affichage. (défaut : valeur de name)
défaut (false|integer): Si cet \SearchWP\Attribute doit être activé par défaut, renvoyer int. (défaut : false)
options (array|callable): Lorsqu'elles sont fournies, plusieurs instances de cet \SearchWP\Attribute sont prises en compte, par exemple les champs personnalisés avec chacun une meta_key. (défaut : [])
allow_custom (boolean): Si des options définies par l'utilisateur peuvent être ajoutées. (défaut : false)
phrases (boolean|array): Si cet \SearchWP\Attribute doit prendre en charge la recherche par phrases. (défaut : false); Lorsque array les clés de tableau suivantes s'appliquent :; table (string) Le nom de la table de base de données.; column (string) La colonne de la table de base de données pour faire correspondre les phrases.; id (string) La colonne de la table de base de données qui suit les identifiants d'entrée.
data (mixed): Les données pour cet \SearchWP\Attribute. (défaut : null); Lorsque callable les arguments suivants sont passés :; id (string) ID de \SearchWP\Source.; chosen_option (string) L'option \SearchWP\Attribute choisie le cas échéant.

En travaillant avec \SearchWP\Attribute, il y a un certain nombre de méthodes à considérer.

get_name(): Obtenseur pour le nom.
get_label( $source ): Getter pour le libellé. Si un \SearchWP\Source est fourni, le filtre searchwp\source\attribute\label est appliqué.
get_phrases(): Getter pour la valeur de l'argument de prise en charge des phrases.
options_static(): Si options est statique (par opposition à callable).
get_options(): Getter pour options.
get_settings(): Accesseur pour les paramètres (c'est-à-dire tels qu'ils sont considérés par un \SearchWP\Engine).
get_default(): Getter pour default.
set_settings() (integer|array $settings): Setter pour les paramètres (c'est-à-dire tels qu'ils sont considérés par un \SearchWP\Engine). Utilisez integer lorsqu'il n'y a pas d'options, sinon utilisez array avec des clés pour chaque option et des valeurs integer correspondantes.
get_data() ( $id, $option = '', $raw = false ): Getter pour data.; $id (string) ID de \SearchWP\Source.; $option (string) Valeur de option, le cas échéant.; $raw (boolean) Indique s'il faut retourner les données brutes, par défaut, il faut les tokeniser.

Il existe un certain nombre de hooks disponibles pour modifier davantage le comportement de \SearchWP\Attribute :