Interface

eZ\Publish\API\Repository\Values\Content\Query\CustomFieldInterface

interface CustomFieldInterface

Interface for criteria and sort clauses, which defines a custom field mapping.

Allows to map the field in a certain type to a custom column / field / index in the search backend and retrieve it back from the criterion. The SPI implementation may or may not handle this information for criteria and sort clauses implementing this interface.

Methods

setCustomField(string $type, string $field, string $customField)

Set a custom field to query or sort on.

mixed getCustomField(string $type, string $field)

Return the custom field to query or sort on if set.

Details

at line 30
public setCustomField(string $type, string $field, string $customField)

Set a custom field to query or sort on.

Set a custom field to query or sort on for a defined field in a defined type.

Parameters

string $type
string $field
string $customField

at line 40
public mixed getCustomField(string $type, string $field)

Return the custom field to query or sort on if set.

Parameters

string $type
string $field

Return Value

mixed If no custom field is set, return null