`\SearchWP\Rule`

Sumário

Uso Básico
Argumentos
Métodos

\SearchWP\Rule é responsável por modelar as restrições sobre quais resultados de pesquisa (\SearchWP\Entry) são considerados ao executar uma \SearchWP\Query. Por exemplo:

Excluir Posts na Categoria “Sem Categoria”
Mostrar apenas Atualizações publicadas nos últimos 6 meses
etc…

Em oposição a db_where() em um \SearchWP\Source que sempre se aplica, \SearchWP\Rules são voltados para o usuário e são estabelecidos ao configurar Motores. \SearchWP\Rules são aplicados tanto durante a indexação quanto na pesquisa.

Argumentos

Ao instanciar um novo \SearchWP\Rule, um array dos seguintes pode ser fornecido:

name (string): Um nome único. (padrão: '')
label (string): Rótulo de exibição. (padrão: valor de name)
options (false|array|callable): Opções. (padrão: false)
option_values_ajax_tag (string): Callback AJAX para buscar options dinamicamente. (padrão: valor de '')
conditions (false|array): Condições que podem ser aplicadas. (padrão: false); Quando array os seguintes valores podem ser usados: '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS', 'NOT EXISTS'
values (false|\SearchWP\Option[]): Quando options são disponibilizadas, estes são os values correspondentes para escolher. (padrão: false); Quando callable, os seguintes argumentos são passados:; $option (string) A option escolhida.; $search (string) String de pesquisa ao pesquisar.; $include (string) options a serem usadas como limitador ao retornar.
application (array|callable): A aplicação desta \SearchWP\Rule. Retorna uma instrução SQL preparada que se aplica, ou um array de IDs de \SearchWP\Entry que satisfazem a \SearchWP\Rule. (padrão: null); Quando callable o seguinte argumento (array com as seguintes chaves) é passado:; 'option' (string) A option escolhida.; 'value' (string) O value escolhido.; 'condition' (string) A condition escolhida.

Métodos

Ao trabalhar com \SearchWP\Rule, há uma série de métodos a serem considerados.

get_name(): Getter para o nome.
get_label(): Getter para o rótulo.
get_options(): Getter para opções.
get_conditions(): Getter para condições.
get_values( $option = '', $search = false, array $include = [] ): Getter para valores.
get_application( array $settings ): Getter para aplicação.
get_settings(): Getter para configurações (ou seja, como considerado por um \SearchWP\Engine).

\SearchWP\Rule

Argumentos

Métodos

Crie uma Experiência de Pesquisa WordPress Melhor Hoje

`\SearchWP\Rule`