abstract class MappingSteps in GatherContent 8.5

Class MappingSteps.

@package Drupal\gathercontent_ui\Form

Hierarchy

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

File

gathercontent_ui/src/Form/MappingEditSteps/MappingSteps.php, line 20

Namespace

Drupal\gathercontent_ui\Form\MappingEditSteps

abstract class MappingSteps {
  use StringTranslationTrait;
  use DependencySerializationTrait;

  /**
   * Mapping object.
   *
   * @var \Drupal\gathercontent\Entity\Mapping
   */
  public $mapping;

  /**
   * Template object.
   *
   * @var \Cheppers\GatherContent\DataTypes\Template
   */
  public $template;

  /**
   * Array of entity reference fields in mapping.
   *
   * @var array
   */
  protected $entityReferenceFields;

  /**
   * Array of entity reference fields in mapping.
   *
   * @var array
   */
  protected $entityReferenceFieldsOptions;

  /**
   * MetatagQuery helper object.
   *
   * @var \Drupal\gathercontent\MetatagQuery
   */
  protected $metatagQuery;

  /**
   * MappingSteps constructor.
   *
   * @param \Drupal\gathercontent\Entity\MappingInterface $mapping
   *   Mapping object.
   * @param array $template
   *   Template array.
   */
  public function __construct(MappingInterface $mapping, array $template) {
    $this->mapping = $mapping;
    $this->template = $template;

    /** @var \Drupal\gathercontent\MetatagQuery $metatagQuery */
    $this->metatagQuery = \Drupal::service('gathercontent.metatag');
  }

  /**
   * Sets entityReferenceFields variable.
   *
   * @param array|null $value
   *   Value.
   */
  public function setEntityReferenceFields($value) {
    $this->entityReferenceFields = $value;
  }

  /**
   * Sets entityReferenceFieldsOptions variable.
   *
   * @param array|null $value
   *   Value.
   */
  public function setEntityReferenceFieldsOptions($value) {
    $this->entityReferenceFieldsOptions = $value;
  }

  /**
   * Gets entityReferenceFields variable.
   */
  public function getEntityReferenceFields() {
    return $this->entityReferenceFields;
  }

  /**
   * Gets entityReferenceFieldsOptions variable.
   */
  public function getEntityReferenceFieldsOptions() {
    return $this->entityReferenceFieldsOptions;
  }

  /**
   * Returns form array.
   *
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   Form state object.
   *
   * @return mixed
   *   Return form array.
   */
  public function getForm(FormStateInterface $formState) {
    $form['form_description'] = [
      '#type' => 'html_tag',
      '#tag' => 'i',
      '#value' => $this
        ->t('Please map your GatherContent Template fields to your Drupal
      Content Type Fields. Please note that a GatherContent field can only be
      mapped to a single Drupal field. So each field can only be mapped to once.'),
    ];
    $form['gathercontent_project'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Project name:'),
      '#markup' => $this->mapping
        ->getGathercontentProject(),
      '#wrapper_attributes' => [
        'class' => [
          'inline-label',
        ],
      ],
    ];
    $form['gathercontent'] = [
      '#type' => 'container',
    ];
    $form['gathercontent']['gathercontent_template'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('GatherContent template:'),
      '#markup' => $this->mapping
        ->getGathercontentTemplate(),
      '#wrapper_attributes' => [
        'class' => [
          'inline-label',
        ],
      ],
    ];
    return $form;
  }

  /**
   * Do validation.
   */
  public function doValidate(array &$form, FormStateInterface $formState) {
    $form_definition_elements = [
      'return',
      'form_build_id',
      'form_token',
      'form_id',
      'op',
    ];
    $non_data_elements = array_merge($form_definition_elements, [
      'content_type',
      'entity_type',
      'id',
      'updated',
      'gathercontent_project',
      'gathercontent_template',
      'er_mapping_type',
      'submit',
      'close',
    ]);
    $mapping_data = [];
    foreach ($formState
      ->getValues() as $key => $value) {
      if (!in_array($key, $non_data_elements)) {
        $mapping_data[$key] = $value;
      }
    }

    // Check if is translatable.
    $entity_type = empty($this->mapping
      ->getMappedEntityType()) ? $formState
      ->getValue('entity_type') : $this->mapping
      ->getMappedEntityType();
    $content_type = empty($this->mapping
      ->getContentType()) ? $formState
      ->getValue('content_type') : $this->mapping
      ->getContentType();
    $translatable = \Drupal::moduleHandler()
      ->moduleExists('content_translation') && \Drupal::service('content_translation.manager')
      ->isEnabled($entity_type, $content_type);

    // Validate if each language is used only once
    // for translatable content types.
    $content_lang = [];
    $metatag_lang = [];
    if ($translatable) {
      foreach ($mapping_data as $groupId => $group) {
        $groupType = isset($group['type']) ? $group['type'] : 'content';
        if ($group['language'] != 'und') {
          if (!in_array($group['language'], ${$groupType . '_lang'})) {
            ${$groupType . '_lang'}[] = $group['language'];
          }
          else {
            $element = $groupId . '[language]';
            $formState
              ->setErrorByName($element, $this
              ->t('Each language can be used only once'));
          }
        }
      }
    }

    // Validate if each field is used only once.
    $content_fields = [];
    $metatag_fields = [];
    if ($translatable) {
      foreach ($content_lang as $lang) {
        $content_fields[$lang] = [];
      }
      foreach ($metatag_lang as $lang) {
        $metatag_fields[$lang] = [];
      }
      $content_fields[LanguageInterface::LANGCODE_NOT_SPECIFIED] = $metatag_fields[LanguageInterface::LANGCODE_NOT_SPECIFIED] = [];
    }
    foreach ($mapping_data as $groupId => $group) {
      $groupType = isset($group['type']) ? $group['type'] : 'content';
      if (isset($group['elements'])) {
        foreach ($group['elements'] as $k => $element) {
          if (empty($element)) {
            continue;
          }
          if ($translatable) {
            if ($groupType == 'content' && in_array($this->template['related']->structure->groups[$groupId]->fields[$k]->type, [
              'text',
              'guidelines',
            ]) || !in_array($element, ${$groupType . '_fields'}[$group['language']])) {
              ${$groupType . '_fields'}[$group['language']][] = $element;
            }
            else {
              if (!strpos($element, '||')) {
                $formState
                  ->setErrorByName($groupId, $this
                  ->t('A GatherContent field can only be mapped to a single Drupal field. So each field can only be mapped to once.'));
              }
            }
          }
          else {
            if ($groupType == 'content' && in_array($this->template['related']->structure->groups[$groupId]->fields[$k]->type, [
              'text',
              'guidelines',
            ]) || !in_array($element, ${$groupType . '_fields'})) {
              ${$groupType . '_fields'}[] = $element;
            }
            else {
              if (!strpos($element, '||')) {
                $formState
                  ->setErrorByName($groupId, $this
                  ->t('A GatherContent field can only be mapped to a single Drupal field. So each field can only be mapped to once.'));
              }
            }
          }
        }
      }
    }

    // Validate if at least one field in mapped.
    if (!$translatable && empty($content_fields) && empty($metatag_fields)) {
      $formState
        ->setErrorByName('form', $this
        ->t('You need to map at least one field to create mapping.'));
    }
    elseif ($translatable && count($content_fields) === 1 && empty($content_fields[LanguageInterface::LANGCODE_NOT_SPECIFIED]) && empty($metatag_fields[LanguageInterface::LANGCODE_NOT_SPECIFIED]) && count($metatag_fields) === 1) {
      $formState
        ->setErrorByName('form', $this
        ->t('You need to map at least one field to create mapping.'));
    }

    // Validate if title is mapped for translatable content.
    if ($translatable) {
      $titleField = $entity_type . '.' . $content_type . '.title';
      foreach ($content_fields as $k => $lang_fields) {
        if (!in_array($titleField, $lang_fields) && !in_array('title', $lang_fields) && $k !== LanguageInterface::LANGCODE_NOT_SPECIFIED) {
          $formState
            ->setErrorByName('form', $this
            ->t('You have to map Drupal Title field for translatable content.'));
        }
      }
    }
  }

  /**
   * Wrapper function for filterFieldsRecursively.
   *
   * Use for filtering only equivalent fields.
   *
   * @param \Cheppers\GatherContent\DataTypes\Element $gc_field
   *   Type of field in GatherContent.
   * @param string $content_type
   *   Name of Drupal content type.
   * @param string $entity_type
   *   Name of Drupal entity type.
   *
   * @return array
   *   Associative array with equivalent fields.
   */
  protected function filterFields(Element $gc_field, $content_type, $entity_type = 'node') {
    return $this
      ->filterFieldsRecursively($gc_field, $content_type, $entity_type);
  }

  /**
   * Helper function.
   *
   * Use for filtering only equivalent fields.
   *
   * @param object $gc_field
   *   Type of field in GatherContent.
   * @param string $content_type
   *   Name of Drupal content type.
   * @param string $entity_type
   *   Name of Drupal Entity type.
   * @param array $nested_ids
   *   Nested ID array.
   * @param string $bundle_label
   *   Bundle label string.
   *
   * @return array
   *   Associative array with equivalent fields.
   */
  protected function filterFieldsRecursively($gc_field, $content_type, $entity_type = 'node', array $nested_ids = [], $bundle_label = '') {
    $mapping_array = [
      'attachment' => [
        'file',
        'image',
        'entity_reference_revisions',
      ],
      'guidelines' => [
        'text_long',
        'entity_reference_revisions',
      ],
      'text' => [
        'text',
        'text_long',
        'text_with_summary',
        'string_long',
        'string',
        'email',
        'telephone',
        'date',
        'datetime',
        'entity_reference_revisions',
      ],
      'choice_radio' => [
        'string',
        'entity_reference',
        'entity_reference_revisions',
      ],
      'choice_checkbox' => [
        'list_string',
        'entity_reference',
        'entity_reference_revisions',
      ],
    ];
    $entityFieldManager = \Drupal::service('entity_field.manager');
    $entityTypeManager = \Drupal::entityTypeManager();
    $entityDefinition = $entityTypeManager
      ->getDefinition($entity_type);
    $titleKey = $entityDefinition
      ->getKey('label');

    /** @var \Drupal\Core\Field\FieldDefinitionInterface[] $instances */
    $instances = $entityFieldManager
      ->getFieldDefinitions($entity_type, $content_type);
    $fields = [];

    // Fields.
    foreach ($instances as $instance) {
      if ($instance instanceof BaseFieldDefinition) {

        // Set label field.
        if ($gc_field->type === 'text' && $gc_field instanceof ElementText && $gc_field->metaData->isPlain && $titleKey == $instance
          ->getName()) {
          $fields[$titleKey] = $instance
            ->getLabel();
        }
        continue;
      }
      if (in_array($instance
        ->getType(), $mapping_array[$gc_field->type])) {

        // Constrains:
        // - do not map plain text (Drupal) to rich text (GC).
        // - do not map radios (GC) to text (Drupal),
        // if widget isn't provided by select_or_other module.
        // - do not map section (GC) to plain text (Drupal).
        // - map only taxonomy entity reference (Drupal) to radios
        // and checkboxes (GC).
        switch ($gc_field->type) {
          case 'text':
            if ((!isset($gc_field->metaData->isPlain) || !$gc_field->metaData->isPlain) && in_array($instance
              ->getType(), [
              'string',
              'string_long',
              'email',
              'telephone',
            ])) {
              continue 2;
            }
            break;
          case 'section':
            if (in_array($instance
              ->getType(), [
              'string',
              'string_long',
            ])) {
              continue 2;
            }
            break;
          case 'choice_radio':
          case 'choice_checkbox':
            if ($instance
              ->getType() !== 'entity_reference_revisions' && $instance
              ->getSetting('handler') !== 'default:taxonomy_term') {
              continue 2;
            }
            break;
        }
        $fieldStorageDefinition = $instance
          ->getFieldStorageDefinition();
        if ($instance
          ->getType() === 'entity_reference_revisions') {
          $settings = $instance
            ->getSetting('handler_settings');
          if (!empty($settings['target_bundles'])) {
            $bundles = $settings['target_bundles'];
            if (!empty($settings['negate']) && !empty($settings['target_bundles_drag_drop'])) {
              $negated_bundles = array_filter($settings['target_bundles_drag_drop'], function ($v) {
                return !$v['enabled'];
              });
              $bundles = array_combine(array_keys($negated_bundles), array_keys($negated_bundles));
            }
            $target_type = $fieldStorageDefinition
              ->getSetting('target_type');
            $bundle_entity_type = $entityTypeManager
              ->getStorage($target_type)
              ->getEntityType()
              ->get('bundle_entity_type');
            $new_nested_ids = $nested_ids;
            $new_nested_ids[] = $instance
              ->id();
            foreach ($bundles as $bundle) {
              $new_bundle_label = (!empty($bundle_label) ? $bundle_label . ' - ' : '') . $instance
                ->getLabel();
              $bundle_name = $entityTypeManager
                ->getStorage($bundle_entity_type)
                ->load($bundle)
                ->label();
              $new_bundle_label .= ' (bundle: ' . $bundle_name . ')';
              $targetFields = $this
                ->filterFieldsRecursively($gc_field, $bundle, $target_type, $new_nested_ids, $new_bundle_label);
              if (!empty($targetFields)) {
                $fields = $fields + $targetFields;
              }
            }
          }
        }
        else {
          $key = $instance
            ->id();
          $instanceIsMultiple = $fieldStorageDefinition
            ->isMultiple();

          // GC field is a multi value field.
          if (!empty($gc_field->metaData->repeatable['isRepeatable']) && $gc_field->metaData->repeatable['isRepeatable']) {
            if (!$instanceIsMultiple) {
              continue;
            }
            $instanceCardinality = $fieldStorageDefinition
              ->getCardinality();

            // Has unlimited values.
            if ($gc_field->metaData->repeatable['limitEnabled'] === FALSE) {
              if ($instanceCardinality > 0) {
                continue;
              }
            }
            else {

              // Has limited values.
              if ($gc_field->metaData->repeatable['limit'] !== $instanceCardinality) {
                continue;
              }
            }
          }
          else {

            // Single values.
            if ($instanceIsMultiple && $gc_field->type === 'text') {
              continue;
            }
          }
          if (!empty($nested_ids)) {
            $new_nested_ids = $nested_ids;
            $new_nested_ids[] = $instance
              ->id();
            $key = implode('||', $new_nested_ids);
          }
          $fields[$key] = (!empty($bundle_label) ? $bundle_label . ' - ' : '') . $instance
            ->getLabel();
          if ($instance
            ->getType() === 'entity_reference' && $instance
            ->getSetting('handler') === 'default:taxonomy_term') {
            $mappingData = unserialize($this->mapping
              ->getData());
            if ($mappingData) {
              foreach ($mappingData as $groupName => $group) {
                $gcField = array_search($key, $group['elements']);
                if (empty($gcField)) {
                  continue;
                }
                if (isset($group['language'])) {
                  $this->entityReferenceFields[$key][$group['language']]['name'] = $gcField;
                  $this->entityReferenceFields[$key][$group['language']]['tab'] = $groupName;
                }
                else {
                  $this->entityReferenceFields[$key][LanguageInterface::LANGCODE_NOT_SPECIFIED]['name'] = $gcField;
                  $this->entityReferenceFields[$key][LanguageInterface::LANGCODE_NOT_SPECIFIED]['tab'] = $groupName;
                }
              }
            }
            if (empty($this->entityReferenceFieldsOptions) || !in_array($key, $this->entityReferenceFieldsOptions)) {
              $this->entityReferenceFieldsOptions[] = $key;
            }
          }
        }
      }
    }
    return $fields;
  }

  /**
   * Return only supported metatag fields.
   *
   * @param object $gathercontent_field
   *   Object of field from GatherContent.
   * @param string $content_type
   *   Machine name of the content type.
   * @param string $entity_type
   *   Machine name of the entity type.
   *
   * @return array
   *   Array of supported metatag fields.
   */
  protected function filterMetatags($gathercontent_field, $content_type, $entity_type = 'node') {
    if ($gathercontent_field->type === 'text' && isset($gathercontent_field->metaData->isPlain) && $gathercontent_field->metaData->isPlain) {

      /** @var \Drupal\gathercontent\MetatagQuery $metatagQuery */
      $metatagQuery = \Drupal::service('gathercontent.metatag');
      return $metatagQuery
        ->getMetatagFields($entity_type, $content_type);
    }
    else {
      return [];
    }
  }

  /**
   * Get list of languages as assoc array.
   *
   * @return array
   *   Assoc array of languages keyed by lang code, value is language name.
   */
  protected function getLanguageList() {
    $languages = \Drupal::service('language_manager')
      ->getLanguages(LanguageInterface::STATE_CONFIGURABLE);
    $language_list = [];
    foreach ($languages as $lang_code => $language) {

      /** @var \Drupal\Core\Language\Language $language */
      $language_list[$lang_code] = $language
        ->getName();
    }
    return $language_list;
  }

  /**
   * Get list of bundle types.
   *
   * @return array
   *   Assoc array of bundle types.
   */
  public function getBundles($entityType) {
    $bundleTypes = \Drupal::service('entity_type.bundle.info')
      ->getBundleInfo($entityType);
    $response = [];
    foreach ($bundleTypes as $key => $value) {
      $response[$key] = $value['label'];
    }
    return $response;
  }

  /**
   * Get list of entity types.
   *
   * @return array
   *   Assoc array of entity types.
   */
  public function getEntityTypes() {
    $entityTypes = \Drupal::entityTypeManager()
      ->getDefinitions();
    $unsupportedTypes = [
      'user',
      'file',
      'menu_link_content',
    ];
    $response = [];
    foreach ($entityTypes as $key => $value) {
      if ($value) {
        $class = $value
          ->getOriginalClass();
        if (in_array(FieldableEntityInterface::class, class_implements($class)) && !in_array($key, $unsupportedTypes)) {
          $label = (string) $value
            ->getLabel();
          $response[$key] = $label;
        }
      }
    }
    return $response;
  }

}

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
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::getForm	public	function	Returns form array.	3
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.