You are here

Home » API reference » Content Synchronization 3.0.x » ContentSingleExportForm.php

class ContentSingleExportForm in Content Synchronization 3.0.x

Same name and namespace in other branches
  1. 8.2 src/Form/ContentSingleExportForm.php \Drupal\content_sync\Form\ContentSingleExportForm
  2. 8 src/Form/ContentSingleExportForm.php \Drupal\content_sync\Form\ContentSingleExportForm

Provides a form for exporting a single content file.

Hierarchy

Expanded class hierarchy of ContentSingleExportForm

1 string reference to 'ContentSingleExportForm'
content_sync.routing.yml in ./content_sync.routing.yml
content_sync.routing.yml

File

src/Form/ContentSingleExportForm.php, line 19

Namespace

Drupal\content_sync\Form
View source 
class ContentSingleExportForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity bundle manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfo
   */
  protected $entityBundleManager;

  /**
   * @var \Drupal\content_sync\Exporter\ContentExporterInterface
   */
  protected $contentExporter;

  /**
   * Constructs a new ContentSingleExportForm.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *
   * @param \Drupal\Core\Entity\EntityTypeBundleInfo $entity_bundle_manager
   *
   * @param \Drupal\content_sync\Exporter\ContentExporterInterface $content_exporter
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfo $entity_bundle_manager, ContentExporterInterface $content_exporter) {
    $this->entityTypeManager = $entity_type_manager;
    $this->entityBundleManager = $entity_bundle_manager;
    $this->contentExporter = $content_exporter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('entity_type.bundle.info'), $container
      ->get('content_sync.exporter'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'config_single_export_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $content_type = 'node', $content_name = NULL, $content_entity = NULL) {
    $entity_types = [];
    $entity_type_definitions = $this->entityTypeManager
      ->getDefinitions();
    foreach ($entity_type_definitions as $entity_type => $definition) {
      if ($definition instanceof ContentEntityType) {
        $entity_types[$entity_type] = $definition
          ->getLabel();
      }
    }
    uasort($entity_types, 'strnatcasecmp');
    $content_types = $entity_types;
    $form['content_type'] = [
      '#title' => $this
        ->t('Content type'),
      '#type' => 'select',
      '#options' => $content_types,
      '#default_value' => $content_type,
      '#attributes' => array(
        'onchange' => 'this.form.content_name.value = null; if(this.form.content_entity){ this.form.content_entity.value = null; } this.form.export.value = null; this.form.submit();',
      ),
    ];
    $default_type = $form_state
      ->getValue('content_type', $content_type);
    $default_name = $form_state
      ->getValue('content_name', $content_name);
    $form['content_name'] = [
      '#title' => $this
        ->t('Content name'),
      '#type' => 'select',
      '#options' => $this
        ->findContent($default_type),
      '#default_value' => $content_name,
      '#attributes' => array(
        'onchange' => 'if(this.form.content_entity){ this.form.content_entity.value = null; } this.form.export.value = null; this.form.submit();',
      ),
    ];

    // Auto-complete field for the content entity
    if ($default_type && $default_name) {
      $form['content_entity'] = [
        '#title' => $this
          ->t('Content Entity'),
        '#type' => 'entity_autocomplete',
        '#target_type' => $default_type,
        '#selection_handler' => 'default',
        '#selection_settings' => [
          'target_bundles' => [
            $default_name,
          ],
        ],
        '#ajax' => [
          'callback' => '::updateExport',
          'wrapper' => 'edit-export-wrapper',
          'event' => 'autocompleteclose',
        ],
      ];

      // Autocomplete doesn't support target bundles parameter on bundle-less entities.
      $target_type = $this->entityTypeManager
        ->getDefinition($default_type);
      $target_type_bundles = $target_type
        ->getBundleEntityType();
      if (is_null($target_type_bundles)) {
        unset($form['content_entity']['#selection_settings']);
      }
    }
    $form['export'] = [
      '#title' => $this
        ->t('Here is your configuration:'),
      '#type' => 'textarea',
      '#rows' => 24,
      '#prefix' => '<div id="edit-export-wrapper">',
      '#suffix' => '</div>',
    ];
    return $form;
  }

  /**
   * Handles switching the content type selector.
   */
  protected function findContent($content_type) {
    $names = [
      '' => $this
        ->t('- Select -'),
    ];

    // For a given entity type, load all entities.
    if ($content_type) {
      $entity_storage = $this->entityBundleManager
        ->getBundleInfo($content_type);
      foreach ($entity_storage as $entityKey => $entity) {
        $entity_id = $entityKey;
        if ($label = $entity['label']) {
          $names[$entity_id] = new TranslatableMarkup('@label (@id)', [
            '@label' => $label,
            '@id' => $entity_id,
          ]);
        }
        else {
          $names[$entity_id] = $entity_id;
        }
      }
    }
    return $names;
  }

  /**
   * Handles switching the export textarea.
   */
  public function updateExport($form, FormStateInterface $form_state) {

    // Get submitted values
    $entity_type = $form_state
      ->getValue('content_type');
    $entity_id = $form_state
      ->getValue('content_entity');

    // DB entity to YAML
    $entity = $this->entityTypeManager
      ->getStorage($entity_type)
      ->load($entity_id);

    // Generate the YAML file.
    $serializer_context = [];
    $exported_entity = $this->contentExporter
      ->exportEntity($entity, $serializer_context);

    // Create the name
    $name = $entity_type . "." . $entity
      ->bundle() . "." . $entity
      ->uuid();

    // Return form values
    $form['export']['#value'] = $exported_entity;
    $form['export']['#description'] = $this
      ->t('Filename: %name', [
      '%name' => $name . '.yml',
    ]);
    return $form['export'];
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Nothing to submit.
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContentSingleExportForm::$contentExporter protected property
ContentSingleExportForm::$entityBundleManager protected property The entity bundle manager.
ContentSingleExportForm::$entityTypeManager protected property The entity type manager.
ContentSingleExportForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ContentSingleExportForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ContentSingleExportForm::findContent protected function Handles switching the content type selector.
ContentSingleExportForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ContentSingleExportForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ContentSingleExportForm::updateExport public function Handles switching the export textarea.
ContentSingleExportForm::__construct public function Constructs a new ContentSingleExportForm.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.