You are here

Home » API reference » File Management 8 » FileManagementEditFileForm.php

class FileManagementEditFileForm in File Management 8

Provides a form for editing files.

Hierarchy

Expanded class hierarchy of FileManagementEditFileForm

File

src/Form/FileManagementEditFileForm.php, line 16

Namespace

Drupal\file_management\Form
View source 
class FileManagementEditFileForm extends FormBase {

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

  /**
   * The file_management service.
   *
   * @var \Drupal\file_management\FileManagement;
   */
  protected $fileManagement;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  public function __construct(FileSystemInterface $file_system, FileManagement $file_management, EntityTypeManagerInterface $entity_type_manager) {
    $this->fileSystem = $file_system;
    $this->fileManagement = $file_management;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('file_system'), $container
      ->get('file_management'), $container
      ->get('entity_type.manager'));
  }
  public function getFormId() {
    return 'file_management';
  }

  /**
   * {@inheritdoc}
   */
  function buildForm(array $form, FormStateInterface $form_state, FileInterface $file = NULL) {
    if (empty($file)) {

      // drupal_set_message
      // return to previous page or file overview page (use route)
    }
    $form['existing_file_details'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Existing file details'),
      '#open' => FALSE,
    ];
    $form['existing_file_details'] += $this->fileManagement
      ->getFileInformation($file);
    $form['new_file_details'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('New file details'),
      '#open' => TRUE,
    ];
    $form['new_file_details']['old_fid'] = [
      '#type' => 'hidden',
      '#value' => $file
        ->id(),
    ];
    $form['new_file_details']['new_file'] = [
      '#title' => $this
        ->t('New file'),
      '#type' => 'file',
      '#description' => $this
        ->t('The new file to be used.<br />' . 'Leave empty to keep the existing file.<br />' . '<strong>Important:</strong> The filename will not be changed unless you specify a new filename below.'),
    ];
    $form['new_file_details']['new_path'] = [
      '#title' => $this
        ->t('New path'),
      '#type' => 'textfield',
      '#description' => $this
        ->t('The new path of the file.' . ' Please specify the full new path.<br />' . ' If no steam wrapper is defined, the existing one will be kept.<br />' . 'Leave empty to keep the existing file where it is.'),
    ];
    $form['new_file_details']['new_filename'] = [
      '#title' => $this
        ->t('New filename'),
      '#type' => 'textfield',
      '#description' => $this
        ->t('The new filename.<br />' . 'Leave empty to keep the existing filename.'),
    ];
    $allowed_file_extensions = $this->fileManagement
      ->getAllowedFileExtensions($file);
    if (!empty($allowed_file_extensions)) {
      $allowed_file_extensions = implode(' ', $allowed_file_extensions);
      $form['new_file_details']['new_filename']['#description'] .= '<br />' . $this
        ->t('Allowed types: @extensions.', [
        '@extensions' => $allowed_file_extensions,
      ]);
    }
    $form['new_file_details']['actions']['#type'] = 'actions';
    $form['new_file_details']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#button_type' => 'primary',
    ];
    $this->fileManagement
      ->addBackButton($form['new_file_details']['actions'], $this
      ->t('Cancel'));
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $new_path = $form_state
      ->getValue('new_path');
    $new_filename = $form_state
      ->getValue('new_filename');
    if (strpos($new_path, '.') !== FALSE) {
      $form_state
        ->setErrorByName('new_path', $this
        ->t('You can not specify a filename in the new path.'));
    }
    if (strpos($new_filename, '\\') !== FALSE || strpos($new_filename, '/') !== FALSE) {
      $form_state
        ->setErrorByName('new_filename', $this
        ->t('You can not specify a path in the new filename.'));
    }
  }

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

    // TODO: Allowed extensions check. If not allowed, remove the file again!
    $old_fid = $form_state
      ->getValue('old_fid');
    $old_file = $this->entityTypeManager
      ->getStorage('file')
      ->load($old_fid);
    $old_uri = $old_file
      ->getFileUri();
    $original_uri = $old_uri;
    $new_filename = $old_file
      ->getFilename();
    $new_uri = $old_file
      ->getFileUri();

    // Check if we have to set a new filename.
    if (!empty($form_state
      ->getValue('new_filename'))) {
      $new_filename = $form_state
        ->getValue('new_filename');
      $new_uri = str_replace($old_file
        ->getFilename(), $new_filename, $new_uri);
    }

    // Check if we have to move the file.
    if (!empty($form_state
      ->getValue('new_path'))) {
      $new_url = parse_url($form_state
        ->getValue('new_path'));
      $old_url = parse_url($old_uri);
      $new_scheme = $old_url['scheme'];
      $new_path = trim($new_url['path'], "\\/");
      if (array_key_exists('scheme', $new_url)) {
        $new_scheme = $new_url['scheme'];
      }
      $new_folder_uri = $new_scheme . '://' . $new_path;
      $new_uri = $new_folder_uri . '/' . $new_filename;
      if ($this->fileSystem
        ->prepareDirectory($new_folder_uri, FileSystemInterface::CREATE_DIRECTORY)) {

        // TODO: Move the file.
      }
      else {

        // TODO: Could not create the needed directory, ABORT!
      }
    }

    // Check if we have to replace the file.
    // TODO: set file_validate_extensions correctly
    // TODO: Also check the return value of file_save_upload()[0] (could be FALSE)
    $new_file = file_save_upload('new_file', [
      'file_validate_extensions' => [],
    ]);
    if (!empty($new_file) && is_array($new_file)) {
      $new_file = $new_file[0];
      $old_uri = $new_file
        ->getFileUri();
      $old_file
        ->setMimeType($new_file
        ->getMimeType());
      $old_file
        ->setSize($new_file
        ->getSize());

      // Delete the old file.
      $this->fileSystem
        ->delete($original_uri);

      // Move the new file to where the old file was.
      // TODO: We should use file_unmanaged_copy() so delete() doesn't throw a warning.
      $this->fileSystem
        ->move($old_uri, $original_uri, FileSystemInterface::EXISTS_REPLACE);
    }
    if ($original_uri !== $new_uri) {

      // TODO: Check if file exists - if so, abort mission [unless it's our file]
      // Move the temporary uploaded file to the new location.
      // TODO: We should use file_unmanaged_copy()
      // So delete() doesn't throw a warning.
      $this->fileSystem
        ->move($original_uri, $new_uri, FileSystemInterface::EXISTS_REPLACE);
    }

    // Delete the db entry of the new file, we've already adapted the old file.
    if (!empty($new_file)) {
      $new_file
        ->delete();
    }

    // Update file details.
    $old_file
      ->setFilename($new_filename);
    $old_file
      ->setFileUri($new_uri);
    $old_file
      ->save();
    if (!empty($new_file) && is_array($new_file)) {

      // Delete the old file physically.
      // this should be after the move happened AND was successful.
      // TODO: don't remove if old_original_uri == new_original_uri.
      $this->fileSystem
        ->delete($old_uri);
    }

    // Flush image styles.
    // TODO: Flush original file.
    $image_styles = ImageStyle::loadMultiple();
    foreach ($image_styles as $image_style) {
      $image_style
        ->flush($new_uri);
    }
    $this
      ->messenger()
      ->addMessage($this
      ->t('@type %title has been updated.', [
      '@type' => $this
        ->t('File'),
      '%title' => $old_file
        ->label(),
    ]));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FileManagementEditFileForm::$entityTypeManager protected property The entity type manager.
FileManagementEditFileForm::$fileManagement protected property The file_management service.
FileManagementEditFileForm::$fileSystem protected property The file system.
FileManagementEditFileForm::buildForm function Form constructor. Overrides FormInterface::buildForm
FileManagementEditFileForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
FileManagementEditFileForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FileManagementEditFileForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FileManagementEditFileForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
FileManagementEditFileForm::__construct public function
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.
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.