class MappingStepEntityReference in GatherContent 8.5

Class MappingStepEntityReference.

@package Drupal\gathercontent_ui\Form\MappingEditSteps

Hierarchy

• class \Drupal\gathercontent_ui\Form\MappingEditSteps\MappingSteps uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\gathercontent_ui\Form\MappingEditSteps\MappingStepEntityReference uses StringTranslationTrait

File

gathercontent_ui/src/Form/MappingEditSteps/MappingStepEntityReference.php, line 14

Namespace

Drupal\gathercontent_ui\Form\MappingEditSteps

class MappingStepEntityReference extends MappingSteps {
  use StringTranslationTrait;

  /**
   * Type of import for entity reference fields.
   *
   * Values:
   * - automatic
   * - manual
   * - semiautomatic.
   *
   * @var string
   */
  protected $erImportType;

  /**
   * Sets the import type.
   *
   * @param string $value
   *   Import type text.
   */
  public function setErImportType($value) {
    $this->erImportType = $value;
  }

  /**
   * {@inheritdoc}
   */
  public function getForm(FormStateInterface $formState) {
    $entityTypeManager = \Drupal::entityTypeManager();
    $form = [];
    foreach ($this->entityReferenceFields as $field => $gcMapping) {
      $field_id_array = explode('||', $field);
      $field_config = FieldConfig::load($field_id_array[count($field_id_array) - 1]);
      $options = [];
      $header = [];

      // Prepare options for every language.
      foreach ($gcMapping as $lang => $fieldSettings) {
        foreach ($this->template['related']->structure->groups as $group) {
          if ($group->id === $fieldSettings['tab']) {
            foreach ($group->fields as $gcField) {
              if ($gcField->id == $fieldSettings['name']) {
                $header[$lang] = $this
                  ->t('@field (@lang values)', [
                  '@field' => $gcField->label,
                  '@lang' => strtoupper($lang),
                ]);
                if (count($header) === 1 && $this->erImportType === 'manual') {
                  $header['terms'] = $this
                    ->t('Terms');
                }
                foreach ($gcField->metaData->choiceFields['options'] as $option) {
                  $options[$lang][$option['optionId']] = $option['label'];
                }
              }
            }
          }
        }
      }
      $term_options = [];

      // For manual mapping load terms from vocabulary.
      if ($this->erImportType === 'manual') {
        $settings = $field_config
          ->getSetting('handler_settings');

        /** @var \Drupal\taxonomy\Entity\Term[] $terms */
        if (!empty($settings['auto_create_bundle'])) {
          $terms = $entityTypeManager
            ->getStorage('taxonomy_term')
            ->loadByProperties([
            'vid' => $settings['auto_create_bundle'],
          ]);
        }
        else {
          $target = reset($settings['target_bundles']);
          $terms = $entityTypeManager
            ->getStorage('taxonomy_term')
            ->loadByProperties([
            'vid' => $target,
          ]);
        }
        foreach ($terms as $term) {
          $term_options[$term
            ->id()] = $term
            ->getName();
        }
      }
      $field = str_replace('.', '--', $field);

      // Extract available languages and get the first and its options.
      $languages = array_keys($header);
      $first_language = array_shift($languages);
      $first_language_options = array_shift($options);

      // Delete terms from languages, it's not language.
      if (isset($languages[0]) && $languages[0] === 'terms') {
        unset($languages[0]);
      }
      $form[$field] = [
        '#tree' => TRUE,
      ];
      $form[$field]['title'] = [
        '#type' => 'html_tag',
        '#value' => $this
          ->t('Field @field', [
          '@field' => $field_config
            ->getLabel(),
        ]),
        '#tag' => 'h2',
      ];

      // Define table header.
      $form[$field]['table'] = [
        '#type' => 'table',
        '#header' => $header,
      ];

      // Each option in the first language is new row.
      // This solution is not dealing with situation when other languages has
      // more options than first language.
      $rows = 0;
      foreach ($first_language_options as $k => $option) {
        $form[$field]['table'][$rows][$first_language] = [
          '#type' => 'value',
          '#value' => $k,
          '#markup' => $option,
        ];
        if ($this->erImportType === 'manual') {
          $form[$field]['table'][$rows]['terms'] = [
            '#type' => 'select',
            '#options' => $term_options,
            '#title' => $this
              ->t('Taxonomy term options'),
            '#title_display' => 'invisible',
            '#empty_option' => $this
              ->t('- None -'),
          ];
        }
        foreach ($languages as $language) {
          $form[$field]['table'][$rows][$language] = [
            '#type' => 'select',
            '#options' => $options[$language],
            '#title' => $this
              ->t('@lang options', [
              '@lang' => $language,
            ]),
            '#title_display' => 'invisible',
            '#empty_option' => $this
              ->t('- None -'),
          ];
        }
        $rows++;
      }
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MappingStepEntityReference::$erImportType	protected	property	Type of import for entity reference fields.
MappingStepEntityReference::getForm	public	function	Returns form array. Overrides MappingSteps::getForm
MappingStepEntityReference::setErImportType	public	function	Sets the import type.
MappingSteps::$entityReferenceFields	protected	property	Array of entity reference fields in mapping.
MappingSteps::$entityReferenceFieldsOptions	protected	property	Array of entity reference fields in mapping.
MappingSteps::$mapping	public	property	Mapping object.
MappingSteps::$metatagQuery	protected	property	MetatagQuery helper object.
MappingSteps::$template	public	property	Template object.
MappingSteps::doValidate	public	function	Do validation.
MappingSteps::filterFields	protected	function	Wrapper function for filterFieldsRecursively.
MappingSteps::filterFieldsRecursively	protected	function	Helper function.
MappingSteps::filterMetatags	protected	function	Return only supported metatag fields.
MappingSteps::getBundles	public	function	Get list of bundle types.
MappingSteps::getEntityReferenceFields	public	function	Gets entityReferenceFields variable.
MappingSteps::getEntityReferenceFieldsOptions	public	function	Gets entityReferenceFieldsOptions variable.
MappingSteps::getEntityTypes	public	function	Get list of entity types.
MappingSteps::getLanguageList	protected	function	Get list of languages as assoc array.
MappingSteps::setEntityReferenceFields	public	function	Sets entityReferenceFields variable.
MappingSteps::setEntityReferenceFieldsOptions	public	function	Sets entityReferenceFieldsOptions variable.
MappingSteps::__construct	public	function	MappingSteps constructor.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.