Frontend | Backend | Api

Search\Models\Api\View

View

Property Description Returns
availableFullTextQueryTypes Returns list of available `multi_match` query types array
availableFullTextSearchFields Gets list of all available fields for the full text search. If field is an object, it returns its full path separated by dots, e.g. `tags['name']` and `tags['slug']` are returned as `tags.name` and `tags.slug`. Only text fields are returned. array
availableHighlightFields Gets fields list available for highlighting array
availableFilterFields Gets list of all available fields for the filtering. If field is an object, it returns its full path separated by dots, e.g. `tags['name']` and `tags['slug']` are returned as `tags.name` and `tags.slug`. Moreover, if field is a text, ".keyword" suffix is added as that is the proper way to use them for filtering. It does not include "relatedRecords" key in result, but it is available to be used by default, just send it as filter if it is required. array
availableSortFields Gets list of all available fields for the sorting. They are the same as for filtering + "_score" field. array
fullTextQueryType Returns full text query type. Currently, the type of `multi_match` only. Returns default type (best_fields) or the one search by the exact part of the string (phrase_prefix). string
fullTextQueryTypeChangeable Returns if full text query type can be changed from parameters (e.g. from URL). It is forbidden by default. bool
fullTextSearchFields Gets default full text search fields. They look like: `["entityClass" => 1, "name" => 2, "author.displayName" => 3]` ‒ field name as key and its weight in value. When it returns empty array, elasticsearch sets fields automatically according to its settings. array
fullTextSearchFieldsChangeable Returns if full text search fields list can be changed from parameters (e.g. from URL). It is allowed by default. bool
filterFields Gets default filter. Key is a field name, value ‒ filter value. array
changeableFilterFields Gets list of filter fields that can be changed from parameter (e.g. from URL). All available filter fields by default. array
ignoreEmptyFilterFields Gets list of filter fields that are not applied when they are empty. If `category.name=` is passed in parameters and is not listed in this array, only records that have no category will be returned. If it is listed ‒ filtering by "category.name" will be skipped. All available filter fields by default. array
sortFields Gets sort array. It looks like `["created desc", "name"]`. The "asc" could be skipped. array
sortFieldsChangeable Returns if sort can be changed from parameters (e.g. from URL). It is allowed by default. bool
minimumShouldMatch Returns "minimum_should_match" default value. Empty sting means no value is set. string
minimumShouldMatchChangeable Returns if "minimum_should_match" can be changed from parameters (e.g. from URL). It is allowed by default. bool
tieBreaker Gets tiebreaker default value. Empty sting means no value is set. float
tieBreakerChangeable Returns if tiebreaker can be changed from parameters (e.g. from URL). It is allowed by default. bool
fuzzy Returns if fuzziness searching enabled. It is true by default. bool
fuzzyChangeable Returns if fuzziness can be changed from parameters (e.g. from URL). It is true by default. bool
pageSize Gets default page size value. It is got from configuration by default. int
pageSizeChangeable Returns if page size can be changed from parameters (e.g. from URL). It is false by default. bool
highlightFields Gets fields to be highlighted array
highlightFieldsChangeable Returns if highlight be changed from parameters (e.g. from URL). It is true by default. bool
id int
name string
slug string
settings array
created Date the record was created. DateTime
modified Last modification date for the record. DateTime
site Site
masterIndex Returns if view is for master index bool