interface SelectionInterface
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface
- 10 core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface
- 11.x core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionInterface.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface
Interface definition for Entity Reference Selection plugins.
Hierarchy
- interface \Drupal\Core\Plugin\PluginFormInterface
- interface \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface extends \Drupal\Core\Plugin\PluginFormInterface
Expanded class hierarchy of SelectionInterface
All classes that implement SelectionInterface
See also
\Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManager
\Drupal\Core\Entity\Annotation\EntityReferenceSelection
1 file declares its use of SelectionInterface
- EntityAutocomplete.php in core/
lib/ Drupal/ Core/ Entity/ Element/ EntityAutocomplete.php
File
-
core/
lib/ Drupal/ Core/ Entity/ EntityReferenceSelection/ SelectionInterface.php, line 15
Namespace
Drupal\Core\Entity\EntityReferenceSelectionView source
interface SelectionInterface extends PluginFormInterface {
/**
* Gets the list of referenceable entities.
*
* @return array
* A nested array of entities, the first level is keyed by the
* entity bundle, which contains an array of entity labels (escaped),
* keyed by the entity ID.
*/
public function getReferenceableEntities($match = NULL, $match_operator = 'CONTAINS', $limit = 0);
/**
* Counts entities that are referenceable.
*
* @return int
* The number of referenceable entities.
*/
public function countReferenceableEntities($match = NULL, $match_operator = 'CONTAINS');
/**
* Validates which existing entities can be referenced.
*
* @return array
* An array of valid entity IDs.
*/
public function validateReferenceableEntities(array $ids);
/**
* Allows the selection to alter the SelectQuery generated by EntityFieldQuery.
*
* @param \Drupal\Core\Database\Query\SelectInterface $query
* A Select Query object.
*/
public function entityQueryAlter(SelectInterface $query);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
PluginFormInterface::buildConfigurationForm | public | function | Form constructor. | 32 |
PluginFormInterface::submitConfigurationForm | public | function | Form submission handler. | 31 |
PluginFormInterface::validateConfigurationForm | public | function | Form validation handler. | 17 |
SelectionInterface::countReferenceableEntities | public | function | Counts entities that are referenceable. | 4 |
SelectionInterface::entityQueryAlter | public | function | Allows the selection to alter the SelectQuery generated by EntityFieldQuery. | 1 |
SelectionInterface::getReferenceableEntities | public | function | Gets the list of referenceable entities. | 4 |
SelectionInterface::validateReferenceableEntities | public | function | Validates which existing entities can be referenced. | 4 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.