class ConfigImportForm
Same name in other branches
- 9 core/modules/config/src/Form/ConfigImportForm.php \Drupal\config\Form\ConfigImportForm
- 8.9.x core/modules/config/src/Form/ConfigImportForm.php \Drupal\config\Form\ConfigImportForm
- 11.x core/modules/config/src/Form/ConfigImportForm.php \Drupal\config\Form\ConfigImportForm
Defines the configuration import form.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\config\Form\ConfigImportForm extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of ConfigImportForm
1 string reference to 'ConfigImportForm'
- config.routing.yml in core/
modules/ config/ config.routing.yml - core/modules/config/config.routing.yml
File
-
core/
modules/ config/ src/ Form/ ConfigImportForm.php, line 18
Namespace
Drupal\config\FormView source
class ConfigImportForm extends FormBase {
/**
* The configuration storage.
*
* @var \Drupal\Core\Config\StorageInterface
*/
protected $configStorage;
/**
* The file system service.
*
* @var \Drupal\Core\File\FileSystemInterface
*/
protected $fileSystem;
/**
* The settings object.
*
* @var \Drupal\Core\Site\Settings
*/
protected $settings;
/**
* Constructs a new ConfigImportForm.
*
* @param \Drupal\Core\Config\StorageInterface $config_storage
* The configuration storage.
* @param \Drupal\Core\File\FileSystemInterface $file_system
* The file system service.
* @param \Drupal\Core\Site\Settings $settings
* The settings object.
*/
public function __construct(StorageInterface $config_storage, FileSystemInterface $file_system, Settings $settings) {
$this->configStorage = $config_storage;
$this->fileSystem = $file_system;
$this->settings = $settings;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('config.storage.sync'), $container->get('file_system'), $container->get('settings'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'config_import_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$directory = $this->settings
->get('config_sync_directory');
$directory_is_writable = is_writable($directory);
if (!$directory_is_writable) {
$this->messenger()
->addError($this->t('The directory %directory is not writable.', [
'%directory' => $directory,
]));
}
$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')) {
$this->configStorage
->deleteAll();
try {
$archiver = new ArchiveTar($path, 'gz');
$files = [];
foreach ($archiver->listContent() as $file) {
$files[] = $file['filename'];
}
$archiver->extractList($files, $this->settings
->get('config_sync_directory'), '', FALSE, FALSE);
$this->messenger()
->addStatus($this->t('Your configuration files were successfully uploaded and are ready for import.'));
$form_state->setRedirect('config.sync');
} catch (\Exception $e) {
$this->messenger()
->addError($this->t('Could not extract the contents of the tar file. The error message is <em>@message</em>', [
'@message' => $e->getMessage(),
]));
}
$this->fileSystem
->unlink($path);
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigImportForm::$configStorage | protected | property | The configuration storage. | ||
ConfigImportForm::$fileSystem | protected | property | The file system service. | ||
ConfigImportForm::$settings | protected | property | The settings object. | ||
ConfigImportForm::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | |
ConfigImportForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | |
ConfigImportForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
ConfigImportForm::submitForm | public | function | Form submission handler. | Overrides FormInterface::submitForm | |
ConfigImportForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | |
ConfigImportForm::__construct | public | function | Constructs a new ConfigImportForm. | ||
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
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. | 2 | |
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. | ||
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. | 16 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 16 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 2 | |
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. | 3 | |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.