class ContentImportForm in Content Synchronization 8

Defines the content import form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\content_sync\Form\ContentImportForm

1 string reference to 'ContentImportForm'

content_sync.routing.yml in ./content_sync.routing.yml

content_sync.routing.yml

File

src/Form/ContentImportForm.php, line 12

Namespace

Drupal\content_sync\Form

class ContentImportForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $directory = content_sync_get_content_directory('sync');
    $directory_is_writable = is_writable($directory);
    if (!$directory_is_writable) {
      $this
        ->logger('content_sync')
        ->error('The directory %directory is not writable.', [
        '%directory' => $directory,
        'link' => 'Import Archive',
      ]);
      drupal_set_message($this
        ->t('The directory %directory is not writable.', [
        '%directory' => $directory,
      ]), 'error');
    }
    $form['import_tarball'] = [
      '#type' => 'file',
      '#title' => $this
        ->t('Configuration archive'),
      '#description' => $this
        ->t('Allowed types: @extensions.', [
        '@extensions' => 'tar.gz tgz tar.bz2',
      ]),
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Upload'),
      '#disabled' => !$directory_is_writable,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $all_files = $this
      ->getRequest()->files
      ->get('files', []);
    if (!empty($all_files['import_tarball'])) {
      $file_upload = $all_files['import_tarball'];
      if ($file_upload
        ->isValid()) {
        $form_state
          ->setValue('import_tarball', $file_upload
          ->getRealPath());
        return;
      }
    }
    $form_state
      ->setErrorByName('import_tarball', $this
      ->t('The file could not be uploaded.'));
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($path = $form_state
      ->getValue('import_tarball')) {
      $directory = content_sync_get_content_directory('sync');
      emptyDirectory($directory);
      try {
        $archiver = new ArchiveTar($path, 'gz');
        $files = [];
        foreach ($archiver
          ->listContent() as $file) {
          $files[] = $file['filename'];
        }
        $archiver
          ->extractList($files, $directory);
        drupal_set_message($this
          ->t('Your content files were successfully uploaded'));
        $this
          ->logger('content_sync')
          ->notice('Your content files were successfully uploaded', [
          'link' => 'Import Archive',
        ]);
        $form_state
          ->setRedirect('content.sync');
      } catch (\Exception $e) {
        drupal_set_message($this
          ->t('Could not extract the contents of the tar file. The error message is <em>@message</em>', [
          '@message' => $e
            ->getMessage(),
        ]), 'error');
        $this
          ->logger('content_sync')
          ->error('Could not extract the contents of the tar file. The error message is <em>@message</em>', [
          '@message' => $e
            ->getMessage(),
          'link' => 'Import Archive',
        ]);
      }
      drupal_flush_all_caches();
      unlink($path);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentImportForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ContentImportForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ContentImportForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ContentImportForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
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.