PhpSelection
class PhpSelection extends DefaultSelection (View source)
Defines an alternative to the default Entity Reference Selection plugin.
This selection plugin uses PHP for more advanced cases when the entity query cannot filter properly, for example when the target entity type has no 'label' key provided in the entity type plugin definition.
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected EntityTypeManagerInterface | $entityTypeManager | The entity type manager service. |
from DefaultSelection |
| protected EntityFieldManagerInterface | $entityFieldManager | The entity field manager service. |
from DefaultSelection |
| EntityTypeBundleInfoInterface | $entityTypeBundleInfo | Entity type bundle info service. |
from DefaultSelection |
| protected EntityRepositoryInterface | $entityRepository | The entity repository. |
from DefaultSelection |
| protected ModuleHandlerInterface | $moduleHandler | The module handler service. |
from DefaultSelection |
| protected AccountInterface | $currentUser | The current user. |
from DefaultSelection |
Methods
Constructs a new DefaultSelection object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Sets the configuration for this plugin instance.
Calculates dependencies for the configured plugin.
Allows the selection to alter the SelectQuery generated by EntityFieldQuery.
Creates an instance of the plugin.
Form element validation handler; Filters the #value property of an element.
Gets the list of referenceable entities.
Counts entities that are referenceable.
Validates which existing entities can be referenced.
Creates a new entity object that can be used as a valid reference.
Validates which newly created entities can be referenced.
Builds an EntityQuery to get referenceable entities.
Helper method: Passes a query to the alteration system again.
Matches an entity label to an input string.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler, AccountInterface $current_user, EntityFieldManagerInterface $entity_field_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info = NULL, EntityRepositoryInterface $entity_repository)
Constructs a new DefaultSelection object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
array
defaultConfiguration()
Gets default configuration for this plugin.
array
getConfiguration()
Gets this plugin's configuration.
setConfiguration(array $configuration)
Sets the configuration for this plugin instance.
array
calculateDependencies()
Calculates dependencies for the configured plugin.
Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.
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.
entityQueryAlter(SelectInterface $query)
Allows the selection to alter the SelectQuery generated by EntityFieldQuery.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
static
elementValidateFilter($element, FormStateInterface $form_state)
Form element validation handler; Filters the #value property of an element.
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.
EntityInterface
createNewEntity(string $entity_type_id, string $bundle, string $label, int $uid)
Creates a new entity object that can be used as a valid reference.
EntityInterface[]
validateReferenceableNewEntities(array $entities)
Validates which newly created entities can be referenced.
This method should replicate the logic implemented by \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface::validateReferenceableEntities(), but applied to newly created entities that have not been saved yet.
protected QueryInterface
buildEntityQuery(string|null $match = NULL, string $match_operator = 'CONTAINS')
Builds an EntityQuery to get referenceable entities.
protected
reAlterQuery(AlterableInterface $query, $tag, $base_table)
Helper method: Passes a query to the alteration system again.
This allows Entity Reference to add a tag to an existing query so it can ask access control mechanisms to alter it again.
protected bool
matchLabel(mixed $match, string $match_operator, string $label)
Matches an entity label to an input string.