class KeywordsField extends AbstractField (View source)

Properties

protected array $data The current search data. from AbstractField
protected array $requestVariables The list of all the request variables.

Methods

string
renderSearchField()

Generates the HTML for the search form (or an empty string if search is not supported).

__construct(string|null $keywords = null)

Initialize the instance.

jsonSerialize()

{@inheritdoc}

loadDataFromRequest(array $request)

Set the search criteria.

string
getKey()

Get the field key.

string
getDisplayName()

Get the field display name.

filterList(ItemList $list)

Apply the filter to an ItemList instance.

Details

string renderSearchField()

Generates the HTML for the search form (or an empty string if search is not supported).

Return Value

string

See also

\Concrete\Core\Search\Field\AbstractField::renderSearchField()

__construct(string|null $keywords = null)

Initialize the instance.

Parameters

string|null $keywords the keywords to be searched

jsonSerialize()

{@inheritdoc}

See also

\JsonSerializable::jsonSerialize()

loadDataFromRequest(array $request)

Set the search criteria.

Parameters

array $request

See also

FieldInterface::loadDataFromRequest()

string getKey()

Get the field key.

Return Value

string

See also

\Concrete\Core\Search\Field\FieldInterface::getKey()

string getDisplayName()

Get the field display name.

Return Value

string

See also

\Concrete\Core\Search\Field\FieldInterface::getDisplayName()

filterList(ItemList $list)

Apply the filter to an ItemList instance.

Parameters

ItemList $list

See also

\Concrete\Core\Search\Field\FieldInterface::filterList()