Add footer element, styles, and associated settings

[bookstack] / app / Uploads / ImageRepo.php

diff --git a/app/Uploads/ImageRepo.php b/app/Uploads/ImageRepo.php
index 16d1bb3d1ff5c4d3cdbf14ffe24f9577f446b0ea..981c046730d7dc7c805475fc9c04252ce042c0ce 100644 (file)
--- a/app/Uploads/ImageRepo.php
+++ b/app/Uploads/ImageRepo.php
@@ -2,6 +2,8 @@
 
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Entities\Page;
 
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Entities\Page;

+use BookStack\Exceptions\ImageUploadException;
+use Exception;

 use Illuminate\Database\Eloquent\Builder;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
 use Illuminate\Database\Eloquent\Builder;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 


@@ -15,18 +17,13 @@ class ImageRepo
 
     /**
      * ImageRepo constructor.
 
     /**
      * ImageRepo constructor.

-     * @param Image $image
-     * @param ImageService $imageService
-     * @param \BookStack\Auth\Permissions\PermissionService $permissionService
-     * @param \BookStack\Entities\Page $page

      */
     public function __construct(
         Image $image,
         ImageService $imageService,
         PermissionService $permissionService,
         Page $page
      */
     public function __construct(
         Image $image,
         ImageService $imageService,
         PermissionService $permissionService,
         Page $page

-    )
-    {
+    ) {

         $this->image = $image;
         $this->imageService = $imageService;
         $this->restrictionService = $permissionService;
         $this->image = $image;
         $this->imageService = $imageService;
         $this->restrictionService = $permissionService;


@@ -36,10 +33,8 @@ class ImageRepo
 
     /**
      * Get an image with the given id.
 
     /**
      * Get an image with the given id.

-     * @param $id
-     * @return Image

      */
      */

-    public function getById($id)
+    public function getById($id): Image

     {
         return $this->image->findOrFail($id);
     }
     {
         return $this->image->findOrFail($id);
     }


@@ -47,13 +42,8 @@ class ImageRepo
     /**
      * Execute a paginated query, returning in a standard format.
      * Also runs the query through the restriction system.
     /**
      * Execute a paginated query, returning in a standard format.
      * Also runs the query through the restriction system.

-     * @param $query
-     * @param int $page
-     * @param int $pageSize
-     * @param bool $filterOnPage
-     * @return array

      */
      */

-    private function returnPaginated($query, $page = 1, $pageSize = 24)
+    private function returnPaginated($query, $page = 1, $pageSize = 24): array

     {
         $images = $query->orderBy('created_at', 'desc')->skip($pageSize * ($page - 1))->take($pageSize + 1)->get();
         $hasMore = count($images) > $pageSize;
     {
         $images = $query->orderBy('created_at', 'desc')->skip($pageSize * ($page - 1))->take($pageSize + 1)->get();
         $hasMore = count($images) > $pageSize;


@@ -72,13 +62,6 @@ class ImageRepo
     /**
      * Fetch a list of images in a paginated format, filtered by image type.
      * Can be filtered by uploaded to and also by name.
     /**
      * Fetch a list of images in a paginated format, filtered by image type.
      * Can be filtered by uploaded to and also by name.

-     * @param string $type
-     * @param int $page
-     * @param int $pageSize
-     * @param int $uploadedTo
-     * @param string|null $search
-     * @param callable|null $whereClause
-     * @return array

      */
     public function getPaginatedByType(
         string $type,
      */
     public function getPaginatedByType(
         string $type,


@@ -87,7 +70,7 @@ class ImageRepo
         int $uploadedTo = null,
         string $search = null,
         callable $whereClause = null
         int $uploadedTo = null,
         string $search = null,
         callable $whereClause = null

-    )
+    ): array

     {
         $imageQuery = $this->image->newQuery()->where('type', '=', strtolower($type));
 
     {
         $imageQuery = $this->image->newQuery()->where('type', '=', strtolower($type));
 


@@ -111,13 +94,6 @@ class ImageRepo
 
     /**
      * Get paginated gallery images within a specific page or book.
 
     /**
      * Get paginated gallery images within a specific page or book.

-     * @param string $type
-     * @param string $filterType
-     * @param int $page
-     * @param int $pageSize
-     * @param int|null $uploadedTo
-     * @param string|null $search
-     * @return array

      */
     public function getEntityFiltered(
         string $type,
      */
     public function getEntityFiltered(
         string $type,


@@ -126,13 +102,13 @@ class ImageRepo
         int $pageSize = 24,
         int $uploadedTo = null,
         string $search = null
         int $pageSize = 24,
         int $uploadedTo = null,
         string $search = null

-    )
+    ): array

     {
         $contextPage = $this->page->findOrFail($uploadedTo);
         $parentFilter = null;
 
         if ($filterType === 'book' || $filterType === 'page') {
     {
         $contextPage = $this->page->findOrFail($uploadedTo);
         $parentFilter = null;
 
         if ($filterType === 'book' || $filterType === 'page') {

-            $parentFilter = function(Builder $query) use ($filterType, $contextPage) {
+            $parentFilter = function (Builder $query) use ($filterType, $contextPage) {

                 if ($filterType === 'page') {
                     $query->where('uploaded_to', '=', $contextPage->id);
                 } elseif ($filterType === 'book') {
                 if ($filterType === 'page') {
                     $query->where('uploaded_to', '=', $contextPage->id);
                 } elseif ($filterType === 'book') {


@@ -147,16 +123,9 @@ class ImageRepo
 
     /**
      * Save a new image into storage and return the new image.
 
     /**
      * Save a new image into storage and return the new image.

-     * @param UploadedFile $uploadFile
-     * @param string $type
-     * @param int $uploadedTo
-     * @param int|null $resizeWidth
-     * @param int|null $resizeHeight
-     * @param bool $keepRatio
-     * @return Image
-     * @throws \BookStack\Exceptions\ImageUploadException
+     * @throws ImageUploadException

      */
      */

-    public function saveNew(UploadedFile $uploadFile, $type, $uploadedTo = 0, int $resizeWidth = null, int $resizeHeight = null, bool $keepRatio = true)
+    public function saveNew(UploadedFile $uploadFile, string $type, int $uploadedTo = 0, int $resizeWidth = null, int $resizeHeight = null, bool $keepRatio = true): Image

     {
         $image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo, $resizeWidth, $resizeHeight, $keepRatio);
         $this->loadThumbs($image);
     {
         $image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo, $resizeWidth, $resizeHeight, $keepRatio);
         $this->loadThumbs($image);


@@ -164,29 +133,22 @@ class ImageRepo
     }
 
     /**
     }
 
     /**

-     * Save a drawing the the database;
-     * @param string $base64Uri
-     * @param int $uploadedTo
-     * @return Image
-     * @throws \BookStack\Exceptions\ImageUploadException
+     * Save a drawing the the database.
+     * @throws ImageUploadException

      */
      */

-    public function saveDrawing(string $base64Uri, int $uploadedTo)
+    public function saveDrawing(string $base64Uri, int $uploadedTo): Image

     {
         $name = 'Drawing-' . user()->getShortName(40) . '-' . strval(time()) . '.png';
     {
         $name = 'Drawing-' . user()->getShortName(40) . '-' . strval(time()) . '.png';

-        $image = $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo);
-        return $image;
+        return $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo);

     }
 
 
     /**
      * Update the details of an image via an array of properties.
     }
 
 
     /**
      * Update the details of an image via an array of properties.

-     * @param Image $image
-     * @param array $updateDetails
-     * @return Image
-     * @throws \BookStack\Exceptions\ImageUploadException
-     * @throws \Exception
+     * @throws ImageUploadException
+     * @throws Exception

      */
      */

-    public function updateImageDetails(Image $image, $updateDetails)
+    public function updateImageDetails(Image $image, $updateDetails): Image

     {
         $image->fill($updateDetails);
         $image->save();
     {
         $image->fill($updateDetails);
         $image->save();


@@ -194,14 +156,11 @@ class ImageRepo
         return $image;
     }
 
         return $image;
     }
 

-

     /**
      * Destroys an Image object along with its revisions, files and thumbnails.
     /**
      * Destroys an Image object along with its revisions, files and thumbnails.

-     * @param Image $image
-     * @return bool
-     * @throws \Exception
+     * @throws Exception

      */
      */

-    public function destroyImage(Image $image = null)
+    public function destroyImage(Image $image = null): bool

     {
         if ($image) {
             $this->imageService->destroy($image);
     {
         if ($image) {
             $this->imageService->destroy($image);


@@ -211,8 +170,7 @@ class ImageRepo
 
     /**
      * Destroy all images of a certain type.
 
     /**
      * Destroy all images of a certain type.

-     * @param string $imageType
-     * @throws \Exception
+     * @throws Exception

      */
     public function destroyByType(string $imageType)
     {
      */
     public function destroyByType(string $imageType)
     {


@@ -225,15 +183,13 @@ class ImageRepo
 
     /**
      * Load thumbnails onto an image object.
 
     /**
      * Load thumbnails onto an image object.

-     * @param Image $image
-     * @throws \BookStack\Exceptions\ImageUploadException
-     * @throws \Exception
+     * @throws Exception

      */
     protected function loadThumbs(Image $image)
     {
         $image->thumbs = [
             'gallery' => $this->getThumbnail($image, 150, 150, false),
      */
     protected function loadThumbs(Image $image)
     {
         $image->thumbs = [
             'gallery' => $this->getThumbnail($image, 150, 150, false),

-            'display' => $this->getThumbnail($image, 840, null, true)
+            'display' => $this->getThumbnail($image, 1680, null, true)

         ];
     }
 
         ];
     }
 


@@ -241,43 +197,26 @@ class ImageRepo
      * Get the thumbnail for an image.
      * If $keepRatio is true only the width will be used.
      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.
      * Get the thumbnail for an image.
      * If $keepRatio is true only the width will be used.
      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.

-     * @param Image $image
-     * @param int $width
-     * @param int $height
-     * @param bool $keepRatio
-     * @return string
-     * @throws \BookStack\Exceptions\ImageUploadException
-     * @throws \Exception
+     * @throws Exception

      */
      */

-    protected function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false)
+    protected function getThumbnail(Image $image, ?int $width = 220, ?int $height = 220, bool $keepRatio = false): ?string

     {
         try {
             return $this->imageService->getThumbnail($image, $width, $height, $keepRatio);
     {
         try {
             return $this->imageService->getThumbnail($image, $width, $height, $keepRatio);

-        } catch (\Exception $exception) {
+        } catch (Exception $exception) {

             return null;
         }
     }
 
     /**
      * Get the raw image data from an Image.
             return null;
         }
     }
 
     /**
      * Get the raw image data from an Image.

-     * @param Image $image
-     * @return null|string

      */
      */

-    public function getImageData(Image $image)
+    public function getImageData(Image $image): ?string

     {
         try {
             return $this->imageService->getImageData($image);
     {
         try {
             return $this->imageService->getImageData($image);

-        } catch (\Exception $exception) {
+        } catch (Exception $exception) {

             return null;
         }
     }
             return null;
         }
     }

-
-    /**
-     * Get the validation rules for image files.
-     * @return string
-     */
-    public function getImageValidationRules()
-    {
-        return 'image_extension|no_double_extension|mimes:jpeg,png,gif,bmp,webp,tiff';
-    }

 }
 }