You are here

Home » API reference » File Entity (fieldable files) 8.2 » FileController.php

class FileController in File Entity (fieldable files) 8.2

Class FileController

Hierarchy

Expanded class hierarchy of FileController

File

src/Controller/FileController.php, line 21

Namespace

Drupal\file_entity\Controller
View source 
class FileController extends ControllerBase {

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

  /**
   * {@inheritdoc}
   */
  public function __construct(FileSystemInterface $file_system) {
    $this->fileSystem = $file_system;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('file_system'));
  }

  /**
   * Upload
   */
  public function FileAddUpload() {
  }

  /**
   * File
   */
  public function FileAddUploadFile() {
  }

  /**
   * Usage
   *
   * @param $file
   */
  public function FileUsage($file) {

    //@TODO: File Usage here.
  }

  /**
   * Returns a HTTP response for a file being downloaded.
   *
   * @param FileInterface $file
   *   The file to download, as an entity.
   *
   * @return Response
   *   The file to download, as a response.
   */
  public function download(FileInterface $file) {

    // Ensure there is a valid token to download this file.
    if (!$this
      ->config('file_entity.settings')
      ->get('allow_insecure_download')) {
      if (!isset($_GET['token']) || $_GET['token'] !== $file
        ->getDownloadToken()) {
        return new Response(t('Access to file @url denied', array(
          '@url' => $file
            ->getFileUri(),
        )), 403);
      }
    }
    $headers = array(
      'Content-Type' => Unicode::mimeHeaderEncode($file
        ->getMimeType()),
      'Content-Disposition' => 'attachment; filename="' . Unicode::mimeHeaderEncode($this->fileSystem
        ->basename($file
        ->getFileUri())) . '"',
      'Content-Length' => $file
        ->getSize(),
      'Content-Transfer-Encoding' => 'binary',
      'Pragma' => 'no-cache',
      'Cache-Control' => 'must-revalidate, post-check=0, pre-check=0',
      'Expires' => '0',
    );

    // Let other modules alter the download headers.
    \Drupal::moduleHandler()
      ->alter('file_download_headers', $headers, $file);

    // Let other modules know the file is being downloaded.
    \Drupal::moduleHandler()
      ->invokeAll('file_transfer', array(
      $file
        ->getFileUri(),
      $headers,
    ));
    try {
      return new BinaryFileResponse($file
        ->getFileUri(), 200, $headers);
    } catch (FileNotFoundException $e) {
      return new Response(t('File @uri not found', array(
        '@uri' => $file
          ->getFileUri(),
      )), 404);
    }
  }

  /**
   * Return an Ajax dialog command for editing a file inline.
   *
   * @param \Drupal\file\FileInterface $file
   *   The file being edited.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   An Ajax response with a command for opening or closing the a dialog
   *   containing the edit form.
   */
  public function inlineEdit(FileInterface $file) {

    // Build the file edit form.
    $form_object = $this
      ->entityTypeManager()
      ->getFormObject('file', 'inline_edit');
    $form_object
      ->setEntity($file);
    $form_state = (new FormState())
      ->setFormObject($form_object)
      ->disableRedirect();

    // Building the form also submits.
    $form = $this
      ->formBuilder()
      ->buildForm($form_object, $form_state);
    $dialog_selector = '#file-entity-inline-edit-' . $file
      ->id();

    // Return a response, depending on whether it's successfully submitted.
    if (!$form_state
      ->isExecuted()) {

      // Return the form as a modal dialog.
      $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
      $title = $this
        ->t('Edit file @file', [
        '@file' => $file
          ->label(),
      ]);
      $response = AjaxResponse::create()
        ->addCommand(new OpenDialogCommand($dialog_selector, $title, $form, [
        'width' => 800,
      ]));
      return $response;
    }
    else {

      // Return command for closing the modal.
      return AjaxResponse::create()
        ->addCommand(new CloseDialogCommand($dialog_selector));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
FileController::$fileSystem protected property The file system service.
FileController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
FileController::download public function Returns a HTTP response for a file being downloaded.
FileController::FileAddUpload public function Upload
FileController::FileAddUploadFile public function File
FileController::FileUsage public function Usage
FileController::inlineEdit public function Return an Ajax dialog command for editing a file inline.
FileController::__construct public function
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.