class FileManagementController in File Management 8

Provides the view, add pages and title callbacks for file entities.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\file_management\Controller\FileManagementController

File

src/Controller/FileManagementController.php, line 11

Namespace

Drupal\file_management\Controller

class FileManagementController extends ControllerBase {

  /**
   * Provides the file view page.
   *
   * @param \Drupal\file\FileInterface $file
   *   The file entity to edit.
   *
   * @return array
   *   The file edit form.
   */
  public function viewFilePage(FileInterface $file = NULL) {
    if (empty($file)) {

      // drupal_set_message
      // return to previous page or file overview page (use route)
    }
    $file_information = \Drupal::service('file_management')
      ->getFileInformation($file);
    if (!empty(\Drupal::request()->query
      ->get('destination'))) {
      $file_information['actions']['#type'] = 'actions';
      \Drupal::service('file_management')
        ->addBackButton($file_information['actions'], $this
        ->t('Back'));
    }
    return $file_information;
  }

  /**
   * Provides the title for the file view page.
   *
   * @param \Drupal\file\FileInterface $file
   *   The file entity to edit.
   *
   * @return string
   *   The page title.
   */
  public function viewFilePageTitle(FileInterface $file = NULL) {
    if (empty($file)) {
      return $this
        ->t('View file');
    }
    return $this
      ->t('<em>View file</em> @filename', [
      '@filename' => $file
        ->label(),
    ]);
  }

  /**
   * Provides the file edit page.
   *
   * @param \Drupal\file\FileInterface $file
   *   The file entity to edit.
   *
   * @return array
   *   The file edit form.
   */
  public function addFilePage(FileInterface $file = NULL) {
    $build = [
      'form' => \Drupal::formBuilder()
        ->getForm('Drupal\\file_management\\Form\\FileManagementEditFileForm', $file),
    ];
    return $build;
  }

  /**
   * Provides the file edit page.
   *
   * @param \Drupal\file\FileInterface $file
   *   The file entity to edit.
   *
   * @return array
   *   The file edit form.
   */
  public function deleteFilePage(FileInterface $file = NULL) {
    $build = [
      'form' => $this
        ->formBuilder()
        ->getForm('Drupal\\file_management\\Form\\FileManagementDeleteFileConfirmForm', $file),
    ];
    return $build;
  }

  /**
   * Provides the title for the file edit page.
   *
   * @param \Drupal\file\FileInterface $file
   *   The file entity to edit.
   *
   * @return string
   *   The page title.
   */
  public function addFilePageTitle(FileInterface $file = NULL) {
    if (empty($file)) {
      return $this
        ->t('Edit file');
    }
    return $this
      ->t('<em>Edit file</em> @filename', [
      '@filename' => $file
        ->label(),
    ]);
  }

  /**
   * Provides the title for the file edit page.
   *
   * @param \Drupal\file\FileInterface $file
   *   The file entity to edit.
   *
   * @return string
   *   The page title.
   */
  public function deleteFilePageTitle(FileInterface $file = NULL) {
    if (empty($file)) {
      return $this
        ->t('Delete file');
    }
    return $this
      ->t('<em>Delete file</em> @filename', [
      '@filename' => $file
        ->label(),
    ]);
  }

}

Members

Name	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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
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.
FileManagementController::addFilePage	public	function	Provides the file edit page.
FileManagementController::addFilePageTitle	public	function	Provides the title for the file edit page.
FileManagementController::deleteFilePage	public	function	Provides the file edit page.
FileManagementController::deleteFilePageTitle	public	function	Provides the title for the file edit page.
FileManagementController::viewFilePage	public	function	Provides the file view page.
FileManagementController::viewFilePageTitle	public	function	Provides the title for the file view page.
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.