class FileSystemForm in Drupal 9

Same name and namespace in other branches

8 core/modules/system/src/Form/FileSystemForm.php \Drupal\system\Form\FileSystemForm

Configure file system settings for this site.

@internal

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\system\Form\FileSystemForm

Expanded class hierarchy of FileSystemForm

1 string reference to 'FileSystemForm'

system.routing.yml in core/modules/system/system.routing.yml: core/modules/system/system.routing.yml

File

core/modules/system/src/Form/FileSystemForm.php, line 21

Namespace

Drupal\system\Form

View source

class FileSystemForm extends ConfigFormBase {

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The stream wrapper manager.
   *
   * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
   */
  protected $streamWrapperManager;

  /**
   * The file system.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * Constructs a FileSystemForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager
   *   The stream wrapper manager.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file system.
   */
  public function __construct(ConfigFactoryInterface $config_factory, DateFormatterInterface $date_formatter, StreamWrapperManagerInterface $stream_wrapper_manager, FileSystemInterface $file_system) {
    parent::__construct($config_factory);
    $this->dateFormatter = $date_formatter;
    $this->streamWrapperManager = $stream_wrapper_manager;
    $this->fileSystem = $file_system;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('date.formatter'), $container
      ->get('stream_wrapper_manager'), $container
      ->get('file_system'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'system.file',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('system.file');
    $form['file_public_path'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Public file system path'),
      '#markup' => PublicStream::basePath(),
      '#description' => $this
        ->t('A local file system path where public files will be stored. This directory must exist and be writable by Drupal. This directory must be relative to the Drupal installation directory and be accessible over the web. This must be changed in settings.php'),
    ];
    $form['file_public_base_url'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Public file base URL'),
      '#markup' => PublicStream::baseUrl(),
      '#description' => $this
        ->t('The base URL that will be used for public file URLs. This can be changed in settings.php'),
    ];
    $form['file_private_path'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Private file system path'),
      '#markup' => PrivateStream::basePath() ? PrivateStream::basePath() : $this
        ->t('Not set'),
      '#description' => $this
        ->t('An existing local file system path for storing private files. It should be writable by Drupal and not accessible over the web. This must be changed in settings.php'),
    ];
    $form['file_temporary_path'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Temporary directory'),
      '#markup' => $this->fileSystem
        ->getTempDirectory(),
      '#description' => $this
        ->t('A local file system path where temporary files will be stored. This directory should not be accessible over the web. This must be changed in settings.php.'),
    ];

    // Any visible, writable wrapper can potentially be used for the files
    // directory, including a remote file system that integrates with a CDN.
    $options = $this->streamWrapperManager
      ->getDescriptions(StreamWrapperInterface::WRITE_VISIBLE);
    if (!empty($options)) {
      $form['file_default_scheme'] = [
        '#type' => 'radios',
        '#title' => $this
          ->t('Default download method'),
        '#default_value' => $config
          ->get('default_scheme'),
        '#options' => $options,
        '#description' => $this
          ->t('This setting is used as the preferred download method. The use of public files is more efficient, but does not provide any access control.'),
      ];
    }
    $intervals = [
      0,
      21600,
      43200,
      86400,
      604800,
      2419200,
      7776000,
    ];
    $period = array_combine($intervals, array_map([
      $this->dateFormatter,
      'formatInterval',
    ], $intervals));
    $period[0] = $this
      ->t('Never');
    $form['temporary_maximum_age'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Delete temporary files after'),
      '#default_value' => $config
        ->get('temporary_maximum_age'),
      '#options' => $period,
      '#description' => $this
        ->t('Temporary files are not referenced, but are in the file system and therefore may show up in administrative lists. <strong>Warning:</strong> If enabled, temporary files will be permanently deleted and may not be recoverable.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('system.file')
      ->set('temporary_maximum_age', $form_state
      ->getValue('temporary_maximum_age'));
    if ($form_state
      ->hasValue('file_default_scheme')) {
      $config
        ->set('default_scheme', $form_state
        ->getValue('file_default_scheme'));
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FileSystemForm::$dateFormatter	protected	property	The date formatter service.
FileSystemForm::$fileSystem	protected	property	The file system.
FileSystemForm::$streamWrapperManager	protected	property	The stream wrapper manager.
FileSystemForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
FileSystemForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
FileSystemForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FileSystemForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
FileSystemForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
FileSystemForm::__construct	public	function	Constructs a FileSystemForm object. Overrides ConfigFormBase::__construct
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
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.

You are here

class FileSystemForm in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation