1. interface
  2. Concrete
  3. \
  4. Core
  5. \
  6. Search
  7. \
  8. Field
  9. \
  10. FieldInterface

FieldInterface

interface FieldInterface implements JsonSerializable (View source)

Methods

string
getKey()

Get the field key.

string
getDisplayName()

Get the field display name.

string
renderSearchField()

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

filterList(ItemList $list)

Apply the filter to an ItemList instance.

loadDataFromRequest(array $request)

Set the search criteria.

Details

at line 13
string getKey()

Get the field key.

Return Value

string

at line 20
string getDisplayName()

Get the field display name.

Return Value

string

at line 27
string renderSearchField()

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

Return Value

string

at line 34
filterList(ItemList $list)

Apply the filter to an ItemList instance.

Parameters

ItemList $list

at line 41
loadDataFromRequest(array $request)

Set the search criteria.

Parameters

array $request