[DDST-455] BCELN24MIG-161: Feature/base fields #77
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,12 @@ | ||
| { | ||
| "name": "discoverygarden/islandora_citations", | ||
| "type": "drupal-module", | ||
| "require": { | ||
| "islandora/controlled_access_terms": "^2", | ||
| "seboettg/citeproc-php": "^2.6.0", | ||
| "webflo/drupal-finder": "^1.2.2" | ||
| }, | ||
| "suggest": { | ||
| "drupal/base_field_override_ui": "To allow the use of 'base' entity fields in mappings." | ||
| } | ||
| } |
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
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
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
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
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 |
|---|---|---|
|
|
@@ -2,10 +2,17 @@ | |
|
|
||
| namespace Drupal\islandora_citations\Controller; | ||
|
|
||
| use Drupal\base_field_override_ui\BaseFieldOverrideUI; | ||
| use Drupal\Core\Config\Entity\ConfigEntityBundleBase; | ||
| use Drupal\Core\Controller\ControllerBase; | ||
| use Drupal\Core\Entity\EntityFieldManagerInterface; | ||
| use Drupal\Core\Field\Entity\BaseFieldOverride; | ||
| use Drupal\Core\Field\FieldDefinitionInterface; | ||
| use Drupal\Core\Link; | ||
| use Drupal\Core\StringTranslation\StringTranslationTrait; | ||
| use Drupal\Core\Url; | ||
| use Drupal\node\Entity\NodeType; | ||
| use Symfony\Component\DependencyInjection\ContainerInterface; | ||
|
|
||
| /** | ||
| * Returns responses for islandora_citations module routes. | ||
|
|
@@ -15,56 +22,63 @@ class IslandoraCitationsController extends ControllerBase { | |
| use StringTranslationTrait; | ||
|
|
||
| /** | ||
| * Drupal's entity field manager service. | ||
| * | ||
| * @var \Drupal\Core\Entity\EntityFieldManagerInterface | ||
| */ | ||
| protected EntityFieldManagerInterface $entityFieldManager; | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| public static function create(ContainerInterface $container) { | ||
| return parent::create($container) | ||
| ->setEntityFieldManager($container->get('entity_field.manager')); | ||
| } | ||
|
|
||
| /** | ||
| * Setter for the entity field manager service. | ||
| * | ||
| * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entityFieldManager | ||
| * The entity field manager service to set. | ||
| * | ||
| * @return $this | ||
| */ | ||
| public function setEntityFieldManager(EntityFieldManagerInterface $entityFieldManager) : static { | ||
| $this->entityFieldManager = $entityFieldManager; | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Provide arguments for FieldConfigUpdate. | ||
| * | ||
| * @param \Drupal\node\Entity\NodeType $node_type | ||
| * Node type. | ||
| * | ||
| * @return array | ||
| * Form array. | ||
| */ | ||
| public function provideArguments(NodeType $node_type) { | ||
|
|
||
| $header = [ | ||
| 'col1' => $this->t('Field'), | ||
| 'col2' => $this->t('CSL Field'), | ||
| 'col3' => $this->t('Operation'), | ||
| ]; | ||
| $fields = $this->entityFieldManager->getFieldDefinitions('node', $node_type->id()); | ||
|
|
||
| $rows = []; | ||
| foreach ($fields as $field_definition) { | ||
|
|
||
| if (!empty($field_definition->getTargetBundle())) { | ||
| $data = $field_definition->getThirdPartySetting('islandora_citations', 'csl_field'); | ||
| $dataForMappedEntities = $field_definition->getThirdPartySetting('islandora_citations', 'use_entity_checkbox'); | ||
| $rows[] = [ | ||
| $field_definition->getName(), | ||
| $data ? implode(',', $data) : ($dataForMappedEntities ? 'Mapped from entity' : '-'), | ||
| [ | ||
| 'data' => $this->getLinkToField('node', $node_type, $field_definition), | ||
| ], | ||
| ]; | ||
| } | ||
| } | ||
|
|
@@ -76,11 +90,59 @@ public function provideArguments($node_type) { | |
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Helper; generate link to the field configuration page. | ||
| * | ||
| * @param string $type | ||
| * The type of entity to which the field is associated. | ||
| * @param \Drupal\Core\Config\Entity\ConfigEntityBundleBase $bundle | ||
| * The bundle with which the field is associated. | ||
| * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition | ||
| * The field definition of which to link to the configuration page. | ||
| * | ||
| * @return \Drupal\Core\Link|\Drupal\Core\StringTranslation\TranslatableMarkup | ||
| * A link to a page to configure the given field, or a string. | ||
| */ | ||
| protected function getLinkToField(string $type, ConfigEntityBundleBase $bundle, FieldDefinitionInterface $field_definition) { | ||
| $add_destination = static function (Url $url) { | ||
| $query = $url->getOption('query'); | ||
| $query['destination'] = Url::fromRoute('<current>')->toString(); | ||
| $url->setOption('query', $query); | ||
| return $url; | ||
| }; | ||
| /** @var \Drupal\Core\Field\Entity\BaseFieldOverride|\Drupal\field\Entity\FieldConfig $config */ | ||
| $config = $field_definition->getConfig($bundle->id()); | ||
| if ($config instanceof BaseFieldOverride) { | ||
| if ($this->moduleHandler()->moduleExists('base_field_override_ui')) { | ||
| return $config->isNew() ? | ||
| new Link( | ||
| $this->t('Add'), | ||
| $add_destination(BaseFieldOverrideUI::getAddRouteInfo($config)), | ||
| ) : | ||
|
Comment on lines
+118
to
+121
There was a problem hiding this comment. An outdated comment is applicable to this section of code so linking for future reference #77 (comment) And yes I can confirm this is currently not applicable to the list of fields being iterated on, but I see no harm keeping it here in case things get extended/altered to iterate over all base fields rather than just the ones already included in a given content type. |
||
| new Link( | ||
| $this->t('Edit'), | ||
| $add_destination(BaseFieldOverrideUI::getEditRouteInfo($config)), | ||
| ); | ||
| } | ||
|
|
||
| return $this->t('Not applicable'); | ||
| } | ||
| else { | ||
| return new Link( | ||
| $this->t('Edit'), | ||
| $add_destination(Url::fromRoute("entity.field_config.{$type}_field_edit_form", [ | ||
| $bundle->getEntityTypeId() => $bundle->id(), | ||
| 'field_config' => $config->id(), | ||
| ])), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Provide arguments for FieldConfigUpdate. | ||
| * | ||
| * @param \Drupal\paragraphs\Entity\ParagraphsType $paragraphs_type | ||
| * Paragraph type. | ||
| * | ||
| * @return array | ||
| * Form array. | ||
|
|
@@ -101,11 +163,7 @@ public function paragraphsArguments($paragraphs_type) { | |
| $rows[] = [$field_definition->getName(), | ||
| $data ? implode(',', $data) : '-', | ||
| [ | ||
| 'data' => $this->getLinkToField('paragraph', $paragraphs_type, $field_definition), | ||
| ], | ||
| ]; | ||
| } | ||
|
|
||
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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pretty much just:
$form['third_party_settings']avoids have to separately handling things on submission.