SelectionInterface
interface SelectionInterface implements PluginFormInterface (View source)
Interface definition for Entity Reference Selection plugins.
Methods
Gets the list of referenceable entities.
Counts entities that are referenceable.
Validates which existing entities can be referenced.
Allows the selection to alter the SelectQuery generated by EntityFieldQuery.
Details
array
buildConfigurationForm(array $form, FormStateInterface $form_state)
Form constructor.
Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and
array_parents, see \Drupal\Core\Render\Element\FormElement.
validateConfigurationForm(array $form, FormStateInterface $form_state)
Form validation handler.
submitConfigurationForm(array $form, FormStateInterface $form_state)
Form submission handler.
array
getReferenceableEntities(string|null $match = NULL, string $match_operator = 'CONTAINS', int $limit = 0)
Gets the list of referenceable entities.
int
countReferenceableEntities(string $match = NULL, string $match_operator = 'CONTAINS')
Counts entities that are referenceable.
array
validateReferenceableEntities(array $ids)
Validates which existing entities can be referenced.
entityQueryAlter(SelectInterface $query)
Allows the selection to alter the SelectQuery generated by EntityFieldQuery.