OEL-477: Create User profile card pattern, and field group custom form… #48
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
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,272 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types = 1); | ||
|
|
||
| namespace Drupal\oe_whitelabel_helper\Plugin\field_group\FieldGroupFormatter; | ||
|
|
||
| use Drupal\Component\Utility\Xss; | ||
| use Drupal\Core\Entity\EntityFieldManagerInterface; | ||
| use Drupal\Core\Extension\ModuleHandlerInterface; | ||
| use Drupal\Core\Plugin\ContainerFactoryPluginInterface; | ||
| use Drupal\Core\Render\Element; | ||
| use Drupal\field\FieldConfigInterface; | ||
| use Drupal\field_group\FieldGroupFormatterBase; | ||
| use Symfony\Component\DependencyInjection\ContainerInterface; | ||
|
|
||
| /** | ||
| * Plugin implementation of the 'multicolumn' formatter. | ||
| * | ||
| * @FieldGroupFormatter( | ||
| * id = "multicolumn", | ||
| * label = @Translation("Multicolumn formatter"), | ||
| * description = @Translation("Breaks fields evenly into two columns."), | ||
| * supported_contexts = { | ||
| * "view", | ||
| * } | ||
| * ) | ||
| */ | ||
| class MultiColumn extends FieldGroupFormatterBase implements ContainerFactoryPluginInterface { | ||
| /** | ||
| * Module handler service. | ||
| * | ||
| * @var \Drupal\Core\Extension\ModuleHandlerInterface | ||
| */ | ||
| protected $moduleHandler; | ||
|
|
||
| /** | ||
| * The Entity field manager. | ||
| * | ||
| * @var \Drupal\Core\Entity\EntityFieldManagerInterface | ||
| */ | ||
| protected $entityFieldManager; | ||
|
|
||
| /** | ||
| * Render API properties. | ||
| * | ||
| * @var array | ||
| */ | ||
| protected $renderApiProperties = [ | ||
| '#theme', | ||
| '#markup', | ||
| '#prefix', | ||
| '#suffix', | ||
| '#type', | ||
| 'widget', | ||
| ]; | ||
|
|
||
| /** | ||
| * Constructs a Popup object. | ||
| * | ||
| * @param string $plugin_id | ||
| * The plugin_id for the formatter. | ||
| * @param mixed $plugin_definition | ||
| * The plugin implementation definition. | ||
| * @param object $group | ||
| * The group object. | ||
| * @param array $settings | ||
| * The formatter settings. | ||
| * @param string $label | ||
| * The formatter label. | ||
| * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler | ||
| * The module handler service. | ||
| * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager | ||
| * The Entity field manager. | ||
| */ | ||
| public function __construct($plugin_id, $plugin_definition, $group, array $settings, $label, ModuleHandlerInterface $module_handler, EntityFieldManagerInterface $entity_field_manager) { | ||
| parent::__construct($plugin_id, $plugin_definition, $group, $settings, $label); | ||
| $this->moduleHandler = $module_handler; | ||
| $this->entityFieldManager = $entity_field_manager; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { | ||
| return new static( | ||
| $plugin_id, | ||
| $plugin_definition, | ||
| $configuration['group'], | ||
| $configuration['settings'], | ||
| $configuration['label'], | ||
| $container->get('module_handler'), | ||
| $container->get('entity_field.manager') | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function defaultContextSettings($context): array { | ||
| return [ | ||
| 'first_column' => '', | ||
| 'second_column' => '', | ||
| 'hide_table_if_empty' => FALSE, | ||
| ] + parent::defaultSettings(); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function settingsForm(): array { | ||
| $form = parent::settingsForm(); | ||
|
|
||
| $form['first_column'] = [ | ||
| '#title' => $this->t('First column classes'), | ||
| '#description' => $this->t('Add custom classes to the first column.'), | ||
| '#type' => 'textfield', | ||
| '#default_value' => $this->getSetting('first_column'), | ||
| ]; | ||
| $form['second_column'] = [ | ||
| '#title' => $this->t('Second column classes'), | ||
| '#description' => $this->t('Add custom classes to the second column.'), | ||
| '#type' => 'textfield', | ||
| '#default_value' => $this->getSetting('second_column'), | ||
| ]; | ||
|
|
||
| $form['hide_table_if_empty'] = [ | ||
| '#title' => $this->t('Hide the table if empty'), | ||
| '#description' => $this->t('Do not output any table or container markup if there are no rows with values.'), | ||
| '#type' => 'checkbox', | ||
| '#default_value' => $this->getSetting('hide_table_if_empty'), | ||
| ]; | ||
|
|
||
| return $form; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function settingsSummary(): array { | ||
| $summary = parent::settingsSummary(); | ||
| $summary[] = $this->t('Display results as a 2 column table.'); | ||
|
|
||
| return $summary; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function preRender(&$element, $rendering_object): void { | ||
| parent::preRender($element, $rendering_object); | ||
|
|
||
| $element['#mode'] = $this->context; | ||
| // Allow modules to alter the rows, useful for removing empty rows. | ||
| $children = Element::children($element, TRUE); | ||
| $this->moduleHandler->alter('field_group_table_rows', $element, $children); | ||
|
|
||
| if ($this->getSetting('hide_table_if_empty')) { | ||
| field_group_remove_empty_display_groups($element, []); | ||
| if ($element == []) { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| // Elements wrapper. | ||
| $element['#type'] = 'container'; | ||
| $element['#attributes']['class'][] = 'my-3'; | ||
|
|
||
| // Print the fieldset title. | ||
| $element['fieldset_title']['#type'] = 'markup'; | ||
| $element['fieldset_title']['#markup'] = '<h4 class="fw-bold mb-4">' . $this->group->label . '</h4>'; | ||
|
|
||
| // Fieldset data container. | ||
| $element['fieldset']['data']['#type'] = 'container'; | ||
| $element['fieldset']['data']['#attributes']['class'][] = 'row'; | ||
|
|
||
| // Set additional classes per column. | ||
| $classes = ['col-12', 'col-md-6']; | ||
| if ($this->getSetting('first_column')) { | ||
| $first_column_classes = array_merge($classes, [$this->getSetting('first_column')]); | ||
| } | ||
|
|
||
| if ($this->getSetting('second_column')) { | ||
| $second_column_classes = array_merge($classes, [$this->getSetting('second_column')]); | ||
| } | ||
| // Columns container. | ||
| $element['fieldset']['data']['first_column']['#type'] = 'container'; | ||
| $element['fieldset']['data']['first_column']['#attributes'] = [ | ||
| 'class' => $this->getSetting('first_column') ? $first_column_classes : $classes, | ||
| ]; | ||
| $element['fieldset']['data']['second_column']['#type'] = 'container'; | ||
| $element['fieldset']['data']['second_column']['#attributes'] = [ | ||
| 'class' => $this->getSetting('second_column') ? $second_column_classes : $classes, | ||
| ]; | ||
|
|
||
| $this->buildFieldsetColumns($element, $children); | ||
| } | ||
|
|
||
| /** | ||
| * Build the columns of the fieldset. | ||
| */ | ||
| protected function buildFieldsetColumns(array &$element, array $children): void { | ||
| // Number of items in the first columns. | ||
| $first_column_elements = array_slice($children, 0, ceil(count($children) / 2)); | ||
|
There was a problem hiding this comment. I think ceil is waiting for a float not an int There was a problem hiding this comment. In fact ceil can receive both int and floats, but in this case ceil is rounding up for then we have un-even elements. |
||
| // Build fieldset column(s). | ||
| foreach ($children as $key => $field_name) { | ||
| $column = in_array($field_name, $first_column_elements) ? 'first_column' : 'second_column'; | ||
| if ($row = $this->buildRow($element, $field_name)) { | ||
| $element['fieldset']['data'][$column][$field_name] = $row; | ||
| } | ||
| unset($element[$field_name]); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Build the row for requested element. | ||
| * | ||
| * @param array $element | ||
| * Rendering array of an element. | ||
| * @param string $field_name | ||
| * The name of currently handling field. | ||
| * | ||
| * @return array | ||
| * Table row definition on success or an empty array otherwise. | ||
| */ | ||
| protected function buildRow(array $element, string $field_name): array { | ||
| $item = $this->getRowItem($element, $field_name); | ||
| $build = []; | ||
|
|
||
| if (!$item) { | ||
| return $build; | ||
| } | ||
| $item['#attributes'] = ['class' => 'col-12 col-md-6']; | ||
| $build = $item; | ||
|
|
||
| return $build; | ||
| } | ||
|
|
||
| /** | ||
| * Return item definition array. | ||
| * | ||
| * @param array $element | ||
| * Rendering array. | ||
| * @param string $field_name | ||
| * Item field machine name. | ||
| * | ||
| * @return array | ||
| * Item definition array on success or empty array otherwise. | ||
| */ | ||
| protected function getRowItem(array $element, string $field_name): array { | ||
| $item = $element[$field_name] ?? []; | ||
| $is_empty = !is_array($item) || !array_intersect($this->renderApiProperties, array_keys($item)); | ||
|
|
||
| if ($is_empty && $this->getSetting('always_show_field_value') && isset($element['#entity_type'], $element['#bundle'])) { | ||
| $field_definitions = $this->entityFieldManager->getFieldDefinitions($element['#entity_type'], $element['#bundle']); | ||
| $field_definition = $field_definitions[$field_name] ?? NULL; | ||
|
|
||
| if ($field_definition instanceof FieldConfigInterface) { | ||
| $is_empty = FALSE; | ||
|
|
||
| $item = [ | ||
| '#title' => $field_definition->label(), | ||
| '#label_display' => 'above', | ||
| '#markup' => Xss::filter($this->getSetting('empty_field_placeholder')), | ||
| ]; | ||
| } | ||
| } | ||
|
|
||
| $item['#attributes']['class'] = ['row']; | ||
| return $is_empty ? [] : $item; | ||
| } | ||
|
|
||
| } | ||
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,49 @@ | ||
| {# | ||
| /** | ||
| * @file | ||
| * Default template for a field. | ||
| */ | ||
| #} | ||
| {% | ||
| set classes = [ | ||
| bundle|clean_class ~ '__' ~ field_name_clean|clean_class, | ||
| label_display == 'inline' ? 'd-flex', | ||
| ] | ||
| %} | ||
| {% | ||
| set title_classes = [ | ||
| 'field__label', | ||
| 'col-12', | ||
| 'col-md-6', | ||
| label_display == 'visually_hidden' ? 'visually-hidden', | ||
| ] | ||
| %} | ||
|
|
||
| {% if label_hidden %} | ||
| {% if multiple %} | ||
| <div{{ attributes.addClass(classes) }}> | ||
| {% for item in items %} | ||
| <div{{ item.attributes.addClass('field__item col-12 col-md-6') }}>{{ item.content }}</div> | ||
| {% endfor %} | ||
| </div> | ||
| {% else %} | ||
| {% for item in items %} | ||
| <div{{ attributes.addClass(classes) }}>{{ item.content }}</div> | ||
| {% endfor %} | ||
| {% endif %} | ||
| {% else %} | ||
| <div{{ attributes.addClass(classes) }}> | ||
| <div{{ title_attributes.addClass(title_classes) }}> | ||
| {{ label }}{% if label_display == 'inline' %}<span class="me-1">:</span>{% endif %} | ||
| </div> | ||
| {% if multiple %} | ||
| <div class="field__items col-12 col-md-6"> | ||
| {% endif %} | ||
| {% for item in items %} | ||
| <div{{ item.attributes.addClass('field__item col-12 col-md-6') }}>{{ item.content }}</div> | ||
| {% endfor %} | ||
| {% if multiple %} | ||
| </div> | ||
| {% endif %} | ||
| </div> | ||
| {% endif %} |
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.
We have an issue with this according to the complexity, please have a look at https://drone.fpfis.eu/openeuropa/oe_whitelabel/483/20