-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
field-create: Make it easier for field types extending entity referen…
…ce to add target type/bundles options (#5556) * Move entity reference related logic to hook implementations * Remove ensureOption method * Fix cs
- Loading branch information
1 parent
a902fb1
commit 1dee70f
Showing
3 changed files
with
159 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
151 changes: 151 additions & 0 deletions
151
src/Drupal/Commands/field/FieldEntityReferenceHooks.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| <?php | ||
|
|
||
| namespace Drush\Drupal\Commands\field; | ||
|
|
||
| use Consolidation\AnnotatedCommand\AnnotationData; | ||
| use Drupal\Core\Entity\EntityTypeBundleInfoInterface; | ||
| use Drupal\Core\Entity\EntityTypeManagerInterface; | ||
| use Drush\Commands\DrushCommands; | ||
| use Drush\Drupal\Commands\field\EntityTypeBundleValidationTrait; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Question\ChoiceQuestion; | ||
|
|
||
| class FieldEntityReferenceHooks extends DrushCommands | ||
| { | ||
| use EntityTypeBundleValidationTrait; | ||
|
|
||
| /** | ||
| * The entity type manager. | ||
| * | ||
| * @var \Drupal\Core\Entity\EntityTypeManagerInterface | ||
| */ | ||
| protected $entityTypeManager; | ||
|
|
||
| /** | ||
| * The entity type bundle info service. | ||
| * | ||
| * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface | ||
| */ | ||
| protected $entityTypeBundleInfo; | ||
|
|
||
| /** | ||
| * Constructs a new EntityReferenceRevisionsHooks object. | ||
| * | ||
| * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager | ||
| * The entity type manager. | ||
| * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entityTypeBundleInfo | ||
| * The entity type bundle info service. | ||
| */ | ||
| public function __construct( | ||
| EntityTypeManagerInterface $entityTypeManager, | ||
| EntityTypeBundleInfoInterface $entityTypeBundleInfo | ||
| ) { | ||
| $this->entityTypeManager = $entityTypeManager; | ||
| $this->entityTypeBundleInfo = $entityTypeBundleInfo; | ||
| } | ||
|
|
||
| /** | ||
| * @hook on-event field-create-field-storage | ||
| */ | ||
| public function hookFieldStorage(array $values, InputInterface $input): array | ||
| { | ||
| if ($input->getOption('field-type') === 'entity_reference') { | ||
| $values['settings']['target_type'] = $this->getTargetType($input); | ||
| } | ||
|
|
||
| return $values; | ||
| } | ||
|
|
||
| /** | ||
| * @hook on-event field-create-field-config | ||
| */ | ||
| public function hookFieldConfig(array $values, InputInterface $input): array | ||
| { | ||
| if ($input->getOption('field-type') === 'entity_reference') { | ||
| $values['settings']['handler_settings']['target_bundles'] = $this->getTargetBundles($input); | ||
| } | ||
|
|
||
| return $values; | ||
| } | ||
|
|
||
| protected function getTargetType(InputInterface $input): string | ||
| { | ||
| $value = $input->getOption('target-type'); | ||
|
|
||
| if ($value === null && $input->isInteractive()) { | ||
| $value = $this->askReferencedEntityType(); | ||
| } | ||
|
|
||
| if ($value === null) { | ||
| throw new \InvalidArgumentException(dt('The %optionName option is required.', [ | ||
| '%optionName' => 'target-type', | ||
| ])); | ||
| } | ||
|
|
||
| $input->setOption('target-type', $value); | ||
|
|
||
| return $value; | ||
| } | ||
|
|
||
| protected function getTargetBundles(InputInterface $input): ?array | ||
| { | ||
| $targetType = $input->getOption('target-type'); | ||
| $targetTypeDefinition = $this->entityTypeManager->getDefinition($targetType); | ||
| // For the 'target_bundles' setting, a NULL value is equivalent to "allow | ||
| // entities from any bundle to be referenced" and an empty array value is | ||
| // equivalent to "no entities from any bundle can be referenced". | ||
| $targetBundles = null; | ||
|
|
||
| if ($targetTypeDefinition->hasKey('bundle')) { | ||
| if ($referencedBundle = $input->getOption('target-bundle')) { | ||
| $this->validateBundle($targetType, $referencedBundle); | ||
| $referencedBundles = [$referencedBundle]; | ||
| } else { | ||
| $referencedBundles = $this->askReferencedBundles($targetType); | ||
| } | ||
|
|
||
| if (!empty($referencedBundles)) { | ||
| $targetBundles = array_combine($referencedBundles, $referencedBundles); | ||
| } | ||
| } | ||
|
|
||
| return $targetBundles; | ||
| } | ||
|
|
||
| protected function askReferencedEntityType(): string | ||
| { | ||
| $definitions = $this->entityTypeManager->getDefinitions(); | ||
| $choices = []; | ||
|
|
||
| foreach ($definitions as $name => $definition) { | ||
| $label = $this->input->getOption('show-machine-names') | ||
| ? $name | ||
| : sprintf('%s: %s', $definition->getGroupLabel()->render(), $definition->getLabel()); | ||
| $choices[$name] = $label; | ||
| } | ||
|
|
||
| return $this->io()->choice('Referenced entity type', $choices); | ||
| } | ||
|
|
||
| protected function askReferencedBundles(string $targetType): ?array | ||
| { | ||
| $choices = []; | ||
| $bundleInfo = $this->entityTypeBundleInfo->getBundleInfo($targetType); | ||
|
|
||
| if (empty($bundleInfo)) { | ||
| return []; | ||
| } | ||
|
|
||
| foreach ($bundleInfo as $bundle => $info) { | ||
| $label = $this->input->getOption('show-machine-names') ? $bundle : $info['label']; | ||
| $choices[$bundle] = $label; | ||
| } | ||
|
|
||
| $question = (new ChoiceQuestion('Referenced bundles', $choices)) | ||
| ->setMultiselect(true); | ||
|
|
||
| return $this->io()->askQuestion($question) ?: null; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters