BookStack Code Mirror - bookstack/blob - app/Exports/Controllers/PageExportApiController.php

   1 <?php
   2
   3 namespace BookStack\Exports\Controllers;
   4
   5 use BookStack\Entities\Queries\PageQueries;
   6 use BookStack\Exports\ExportFormatter;
   7 use BookStack\Exports\ZipExports\ZipExportBuilder;
   8 use BookStack\Http\ApiController;
   9 use BookStack\Permissions\Permission;
  10 use Throwable;
  11
  12 class PageExportApiController extends ApiController
  13 {
  14     public function __construct(
  15         protected ExportFormatter $exportFormatter,
  16         protected PageQueries $queries,
  17     ) {
  18         $this->middleware(Permission::ContentExport->middleware());
  19     }
  20
  21     /**
  22      * Export a page as a PDF file.
  23      *
  24      * @throws Throwable
  25      */
  26     public function exportPdf(int $id)
  27     {
  28         $page = $this->queries->findVisibleByIdOrFail($id);
  29         $pdfContent = $this->exportFormatter->pageToPdf($page);
  30
  31         return $this->download()->directly($pdfContent, $page->slug . '.pdf');
  32     }
  33
  34     /**
  35      * Export a page as a contained HTML file.
  36      *
  37      * @throws Throwable
  38      */
  39     public function exportHtml(int $id)
  40     {
  41         $page = $this->queries->findVisibleByIdOrFail($id);
  42         $htmlContent = $this->exportFormatter->pageToContainedHtml($page);
  43
  44         return $this->download()->directly($htmlContent, $page->slug . '.html');
  45     }
  46
  47     /**
  48      * Export a page as a plain text file.
  49      */
  50     public function exportPlainText(int $id)
  51     {
  52         $page = $this->queries->findVisibleByIdOrFail($id);
  53         $textContent = $this->exportFormatter->pageToPlainText($page);
  54
  55         return $this->download()->directly($textContent, $page->slug . '.txt');
  56     }
  57
  58     /**
  59      * Export a page as a markdown file.
  60      */
  61     public function exportMarkdown(int $id)
  62     {
  63         $page = $this->queries->findVisibleByIdOrFail($id);
  64         $markdown = $this->exportFormatter->pageToMarkdown($page);
  65
  66         return $this->download()->directly($markdown, $page->slug . '.md');
  67     }
  68
  69     /**
  70      * Export a page as a contained ZIP file.
  71      */
  72     public function exportZip(int $id, ZipExportBuilder $builder)
  73     {
  74         $page = $this->queries->findVisibleByIdOrFail($id);
  75         $zip = $builder->buildForPage($page);
  76
  77         return $this->download()->streamedFileDirectly($zip, $page->slug . '.zip', true);
  78     }
  79 }