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.

protected bool $isLoaded

Determines whether the data is loaded into the field. If this is true, loadFromRequest will not repopulate from request.

from  AbstractField

Methods

string
renderSearchField()

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

jsonSerialize()

{@inheritdoc}

mixed
export(SimpleXMLElement $element)

Exports the data to CIF

denormalize(DenormalizerInterface $denormalizer, $data, $format = null, array $context = [])

No description

setData($key, $value)

No description

mixed|null
getData(string $key)

No description

loadDataFromRequest(array $request)

Set the search criteria.

void
loadDataFromImport(SimpleXMLElement $element)

No description

__construct(string|null $keywords = null)

Initialize the instance.

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

AbstractField::renderSearchField

jsonSerialize()

{@inheritdoc}

See also

\JsonSerializable::jsonSerialize()

mixed export(SimpleXMLElement $element)

Exports the data to CIF

Parameters

SimpleXMLElement $element

Return Value

mixed

denormalize(DenormalizerInterface $denormalizer, $data, $format = null, array $context = [])

No description

Parameters

DenormalizerInterface $denormalizer
$data
$format
array $context

setData($key, $value)

No description

Parameters

$key
$value

mixed|null getData(string $key)

No description

Parameters

string $key

Return Value

mixed|null

loadDataFromRequest(array $request)

Set the search criteria.

Parameters

array $request

See also

FieldInterface::loadDataFromRequest

void loadDataFromImport(SimpleXMLElement $element)

No description

Parameters

SimpleXMLElement $element

Return Value

void

__construct(string|null $keywords = null)

Initialize the instance.

Parameters

string|null $keywords

the keywords to be searched

string getKey()

Get the field key.

Return Value

string

See also

FieldInterface::getKey

string getDisplayName()

Get the field display name.

Return Value

string

See also

FieldInterface::getDisplayName

filterList(ItemList $list)

Apply the filter to an ItemList instance.

Parameters

ItemList $list

See also

FieldInterface::filterList