You are here

class ContentExportForm in Content Synchronization 8.2

Same name and namespace in other branches
  1. 8 src/Form/ContentExportForm.php \Drupal\content_sync\Form\ContentExportForm
  2. 3.0.x src/Form/ContentExportForm.php \Drupal\content_sync\Form\ContentExportForm

Defines the content export form.

Hierarchy

Expanded class hierarchy of ContentExportForm

2 string references to 'ContentExportForm'
content_sync.routing.yml in ./content_sync.routing.yml
content_sync.routing.yml
content_sync.services.yml in ./content_sync.services.yml
content_sync.services.yml
1 service uses ContentExportForm
content_sync.snaphoshot in ./content_sync.services.yml
Drupal\content_sync\Form\ContentExportForm

File

src/Form/ContentExportForm.php, line 17

Namespace

Drupal\content_sync\Form
View source
class ContentExportForm extends FormBase {
  use ContentExportTrait;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

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

  /**
   * @var \Drupal\content_sync\ContentSyncManagerInterface
   */
  protected $contentSyncManager;

  /**
   * ContentExportForm constructor.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ContentExporterInterface $content_exporter, ContentSyncManagerInterface $content_sync_manager, FileSystemInterface $file_system) {
    $this->entityTypeManager = $entity_type_manager;
    $this->contentExporter = $content_exporter;
    $this->contentSyncManager = $content_sync_manager;
    $this->fileSystem = $file_system;
  }
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('content_sync.exporter'), $container
      ->get('content_sync.manager'), $container
      ->get('file_system'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Export'),
    ];
    return $form;
  }

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

    // Delete the content tar file in case an older version exist.
    $this->fileSystem
      ->delete($this
      ->getTempFile());

    //Set batch operations by entity type/bundle
    $entities_list = [];
    $entity_type_definitions = $this->entityTypeManager
      ->getDefinitions();
    foreach ($entity_type_definitions as $entity_type => $definition) {
      $reflection = new \ReflectionClass($definition
        ->getClass());
      if ($reflection
        ->implementsInterface(ContentEntityInterface::class)) {
        $entities = $this->entityTypeManager
          ->getStorage($entity_type)
          ->getQuery()
          ->execute();
        foreach ($entities as $entity_id) {
          $entities_list[] = [
            'entity_type' => $entity_type,
            'entity_id' => $entity_id,
          ];
        }
      }
    }
    if (!empty($entities_list)) {
      $serializer_context['export_type'] = 'tar';
      $serializer_context['include_files'] = 'folder';
      $batch = $this
        ->generateExportBatch($entities_list, $serializer_context);
      batch_set($batch);
    }
  }
  public function snapshot() {

    //Set batch operations by entity type/bundle
    $entities_list = [];
    $entity_type_definitions = $this->entityTypeManager
      ->getDefinitions();
    foreach ($entity_type_definitions as $entity_type => $definition) {
      $reflection = new \ReflectionClass($definition
        ->getClass());
      if ($reflection
        ->implementsInterface(ContentEntityInterface::class)) {
        $entities = $this->entityTypeManager
          ->getStorage($entity_type)
          ->getQuery()
          ->execute();
        foreach ($entities as $entity_id) {
          $entities_list[] = [
            'entity_type' => $entity_type,
            'entity_id' => $entity_id,
          ];
        }
      }
    }
    if (!empty($entities_list)) {
      $serializer_context['export_type'] = 'snapshot';
      $batch = $this
        ->generateExportBatch($entities_list, $serializer_context);
      batch_set($batch);
    }
  }

  /**
   * @{@inheritdoc}
   */
  protected function getEntityTypeManager() {
    return $this->entityTypeManager;
  }

  /**
   * @{@inheritdoc}
   */
  protected function getContentExporter() {
    return $this->contentExporter;
  }

  /**
   * @{@inheritdoc}
   */
  protected function getExportLogger() {
    return $this
      ->logger('content_sync');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContentExportForm::$contentExporter protected property
ContentExportForm::$contentSyncManager protected property
ContentExportForm::$entityTypeManager protected property
ContentExportForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ContentExportForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ContentExportForm::getContentExporter protected function @ Overrides ContentExportTrait::getContentExporter
ContentExportForm::getEntityTypeManager protected function @ Overrides ContentExportTrait::getEntityTypeManager
ContentExportForm::getExportLogger protected function @ Overrides ContentExportTrait::getExportLogger
ContentExportForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ContentExportForm::snapshot public function
ContentExportForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ContentExportForm::__construct public function ContentExportForm constructor.
ContentExportTrait::$archiver protected property
ContentExportTrait::finishContentExportBatch public function Finish batch.
ContentExportTrait::generateExportBatch public function
ContentExportTrait::generateSiteUUIDFile public function Generate UUID YAML file To use for site UUID validation.
ContentExportTrait::getArchiver protected function
ContentExportTrait::getTempFile protected function
ContentExportTrait::processContentExportFiles public function Processes the content archive export batch
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
FormBase::$configFactory protected property The config factory. 1
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. 1
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. Overrides UrlGeneratorTrait::redirect
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 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.