class AttributeKeyField extends AbstractField (View source)

Properties

protected array $data The current search data. from AbstractField
protected array $requestVariables The list of all the request variables. from AbstractField
protected Key|null $attributeKey The attribute key instance.
protected int|null $akID The attribute key ID.

Methods

string
renderSearchField()

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

__construct(Key $attributeKey)

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.

string[]
__sleep()

Return an array with the names of the properties to be serialized.

__wakeup()

Initialize the instance once it has been deserialized.

Details

string renderSearchField()

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

Return Value

string

See also

FieldInterface::renderSearchField()

__construct(Key $attributeKey)

Initialize the instance.

Parameters

Key $attributeKey the attribute key instance

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

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()

string[] __sleep()

Return an array with the names of the properties to be serialized.

Return Value

string[]

__wakeup()

Initialize the instance once it has been deserialized.