class StaticDownloadController in Tome 8

Contains routes related to Tome Static.

@internal

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\tome_static\Controller\StaticDownloadController

Expanded class hierarchy of StaticDownloadController

File

modules/tome_static/src/Controller/StaticDownloadController.php, line 20

Namespace

Drupal\tome_static\Controller

View source

class StaticDownloadController extends ControllerBase {

  /**
   * The static generator.
   *
   * @var \Drupal\tome_static\StaticGeneratorInterface
   */
  protected $static;

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

  /**
   * StaticGeneratorForm constructor.
   *
   * @param \Drupal\tome_static\StaticGeneratorInterface $static
   *   The static generator.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file system.
   */
  public function __construct(StaticGeneratorInterface $static, FileSystemInterface $file_system) {
    $this->static = $static;
    $this->fileSystem = $file_system;
  }

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

  /**
   * Presents a user interface to download a static build.
   */
  public function build() {
    $build = [];
    $download_url = Url::fromRoute('tome_static.download');
    if ($download_url
      ->access()) {
      $build['description'] = [
        '#type' => 'markup',
        '#markup' => '<p>' . $this
          ->t('Download the latest static build of this site as a gzipped tar file.') . '</p>',
      ];
      $build['download'] = [
        '#type' => 'link',
        '#attributes' => [
          'class' => [
            'button',
          ],
        ],
        '#title' => $this
          ->t('Download'),
        '#url' => $download_url,
      ];
    }
    else {
      $build['description'] = [
        '#type' => 'markup',
        '#markup' => '<p>' . $this
          ->t('No static build available for download. <a href=":generate">Click here to generate one.</a>', [
          ':generate' => Url::fromRoute('tome_static.generate')
            ->toString(),
        ]) . '</p>',
      ];
    }
    return $build;
  }

  /**
   * Downloads a tarball of the static build.
   */
  public function download() {
    $path = $this->fileSystem
      ->getTempDirectory() . '/tome_static_export.tar.gz';
    $static_directory = $this->static
      ->getStaticDirectory();
    $this->fileSystem
      ->delete($path);
    $archiver = new ArchiveTar($path, 'gz');
    $archiver
      ->addModify([
      $static_directory,
    ], '', $static_directory);
    $response = new BinaryFileResponse($path, 200, [], FALSE);
    $response
      ->setContentDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT, basename($path));
    return $response;
  }

  /**
   * Custom access callback to determine if there's anything to download.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   The access result.
   */
  public function downloadAccess() {
    return AccessResult::allowedIf(file_exists($this->static
      ->getStaticDirectory()) && (new \FilesystemIterator($this->static
      ->getStaticDirectory()))
      ->valid());
  }

}

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::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.
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.
StaticDownloadController::$fileSystem	protected	property	The file system.
StaticDownloadController::$static	protected	property	The static generator.
StaticDownloadController::build	public	function	Presents a user interface to download a static build.
StaticDownloadController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
StaticDownloadController::download	public	function	Downloads a tarball of the static build.
StaticDownloadController::downloadAccess	public	function	Custom access callback to determine if there's anything to download.
StaticDownloadController::__construct	public	function	StaticGeneratorForm constructor.
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.

You are here

class StaticDownloadController in Tome 8

Hierarchy

File

Namespace

Members

API Navigation