Merge pull request #5491 from BookStackApp/deprecations

ssddanbrown · web-flow · commit d2542d6265ea · 2025-02-23T11:23:35.000Z
Addressing PHP 8.4 Deprecations
diff --git a/app/Access/Ldap.php b/app/Access/Ldap.php
@@ -54,7 +54,7 @@ public function setVersion($ldapConnection, int $version): bool
      *
      * @return \LDAP\Result|array|false
      */
-    public function search($ldapConnection, string $baseDn, string $filter, array $attributes = null)
+    public function search($ldapConnection, string $baseDn, string $filter, array $attributes = [])
     {
         return ldap_search($ldapConnection, $baseDn, $filter, $attributes);
     }
@@ -66,7 +66,7 @@ public function search($ldapConnection, string $baseDn, string $filter, array $a
      *
      * @return \LDAP\Result|array|false
      */
-    public function read($ldapConnection, string $baseDn, string $filter, array $attributes = null)
+    public function read($ldapConnection, string $baseDn, string $filter, array $attributes = [])
     {
         return ldap_read($ldapConnection, $baseDn, $filter, $attributes);
     }
@@ -87,7 +87,7 @@ public function getEntries($ldapConnection, $ldapSearchResult): array|false
      *
      * @param resource|\LDAP\Connection   $ldapConnection
      */
-    public function searchAndGetEntries($ldapConnection, string $baseDn, string $filter, array $attributes = null): array|false
+    public function searchAndGetEntries($ldapConnection, string $baseDn, string $filter, array $attributes = []): array|false
     {
         $search = $this->search($ldapConnection, $baseDn, $filter, $attributes);
 
@@ -99,7 +99,7 @@ public function searchAndGetEntries($ldapConnection, string $baseDn, string $fil
      *
      * @param resource|\LDAP\Connection $ldapConnection
      */
-    public function bind($ldapConnection, string $bindRdn = null, string $bindPassword = null): bool
+    public function bind($ldapConnection, ?string $bindRdn = null, ?string $bindPassword = null): bool
     {
         return ldap_bind($ldapConnection, $bindRdn, $bindPassword);
     }
diff --git a/app/Access/SocialDriverManager.php b/app/Access/SocialDriverManager.php
@@ -92,7 +92,7 @@ public function addSocialDriver(
         string $driverName,
         array $config,
         string $socialiteHandler,
-        callable $configureForRedirect = null
+        ?callable $configureForRedirect = null
     ) {
         $this->validDrivers[] = $driverName;
         config()->set('services.' . $driverName, $config);
diff --git a/app/App/helpers.php b/app/App/helpers.php
@@ -43,9 +43,9 @@ function user(): User
  * Check if the current user has a permission. If an ownable element
  * is passed in the jointPermissions are checked against that particular item.
  */
-function userCan(string $permission, Model $ownable = null): bool
+function userCan(string $permission, ?Model $ownable = null): bool
 {
-    if ($ownable === null) {
+    if (is_null($ownable)) {
         return user()->can($permission);
     }
 
@@ -71,7 +71,7 @@ function userCanOnAny(string $action, string $entityClass = ''): bool
  *
  * @return mixed|SettingService
  */
-function setting(string $key = null, $default = null)
+function setting(?string $key = null, mixed $default = null): mixed
 {
     $settingService = app()->make(SettingService::class);
 
diff --git a/app/Config/exports.php b/app/Config/exports.php
@@ -114,6 +114,7 @@
          * @var array
          */
         'allowed_protocols' => [
+            "data://" => ["rules" => []],
             'file://'  => ['rules' => []],
             'http://'  => ['rules' => []],
             'https://' => ['rules' => []],
diff --git a/app/Entities/Controllers/BookController.php b/app/Entities/Controllers/BookController.php
@@ -70,7 +70,7 @@ public function index(Request $request)
     /**
      * Show the form for creating a new book.
      */
-    public function create(string $shelfSlug = null)
+    public function create(?string $shelfSlug = null)
     {
         $this->checkPermission('book-create-all');
 
@@ -93,7 +93,7 @@ public function create(string $shelfSlug = null)
      * @throws ImageUploadException
      * @throws ValidationException
      */
-    public function store(Request $request, string $shelfSlug = null)
+    public function store(Request $request, ?string $shelfSlug = null)
     {
         $this->checkPermission('book-create-all');
         $validated = $this->validate($request, [
diff --git a/app/Entities/Controllers/PageController.php b/app/Entities/Controllers/PageController.php
@@ -41,7 +41,7 @@ public function __construct(
      *
      * @throws Throwable
      */
-    public function create(string $bookSlug, string $chapterSlug = null)
+    public function create(string $bookSlug, ?string $chapterSlug = null)
     {
         if ($chapterSlug) {
             $parent = $this->entityQueries->chapters->findVisibleBySlugsOrFail($bookSlug, $chapterSlug);
@@ -69,7 +69,7 @@ public function create(string $bookSlug, string $chapterSlug = null)
      *
      * @throws ValidationException
      */
-    public function createAsGuest(Request $request, string $bookSlug, string $chapterSlug = null)
+    public function createAsGuest(Request $request, string $bookSlug, ?string $chapterSlug = null)
     {
         $this->validate($request, [
             'name' => ['required', 'string', 'max:255'],
diff --git a/app/Entities/Queries/QueryPopular.php b/app/Entities/Queries/QueryPopular.php
@@ -18,15 +18,15 @@ public function __construct(
     ) {
     }
 
-    public function run(int $count, int $page, array $filterModels = null): Collection
+    public function run(int $count, int $page, array $filterModels): Collection
     {
         $query = $this->permissions
             ->restrictEntityRelationQuery(View::query(), 'views', 'viewable_id', 'viewable_type')
             ->select('*', 'viewable_id', 'viewable_type', DB::raw('SUM(views) as view_count'))
             ->groupBy('viewable_id', 'viewable_type')
             ->orderBy('view_count', 'desc');
 
-        if ($filterModels) {
+        if (!empty($filterModels)) {
             $query->whereIn('viewable_type', $this->entityProvider->getMorphClasses($filterModels));
         }
 
diff --git a/app/Entities/Repos/RevisionRepo.php b/app/Entities/Repos/RevisionRepo.php
@@ -46,7 +46,7 @@ public function getNewDraftForCurrentUser(Page $page): PageRevision
     /**
      * Store a new revision in the system for the given page.
      */
-    public function storeNewForPage(Page $page, string $summary = null): PageRevision
+    public function storeNewForPage(Page $page, ?string $summary = null): PageRevision
     {
         $revision = new PageRevision();
 
diff --git a/app/Theming/ThemeService.php b/app/Theming/ThemeService.php
@@ -93,7 +93,7 @@ public function readThemeActions(): void
     /**
      * @see SocialDriverManager::addSocialDriver
      */
-    public function addSocialDriver(string $driverName, array $config, string $socialiteHandler, callable $configureForRedirect = null): void
+    public function addSocialDriver(string $driverName, array $config, string $socialiteHandler, ?callable $configureForRedirect = null): void
     {
         $driverManager = app()->make(SocialDriverManager::class);
         $driverManager->addSocialDriver($driverName, $config, $socialiteHandler, $configureForRedirect);
diff --git a/app/Uploads/ImageRepo.php b/app/Uploads/ImageRepo.php
@@ -49,9 +49,9 @@ public function getPaginatedByType(
         string $type,
         int $page = 0,
         int $pageSize = 24,
-        int $uploadedTo = null,
-        string $search = null,
-        callable $whereClause = null
+        ?int $uploadedTo = null,
+        ?string $search = null,
+        ?callable $whereClause = null
     ): array {
         $imageQuery = Image::query()->where('type', '=', strtolower($type));
 
@@ -91,7 +91,7 @@ public function getEntityFiltered(
             $parentFilter = function (Builder $query) use ($filterType, $contextPage) {
                 if ($filterType === 'page') {
                     $query->where('uploaded_to', '=', $contextPage->id);
-                } elseif ($filterType === 'book') {
+                } else if ($filterType === 'book') {
                     $validPageIds = $contextPage->book->pages()
                         ->scopes('visible')
                         ->pluck('id')
@@ -109,8 +109,14 @@ public function getEntityFiltered(
      *
      * @throws ImageUploadException
      */
-    public function saveNew(UploadedFile $uploadFile, string $type, int $uploadedTo = 0, int $resizeWidth = null, int $resizeHeight = null, bool $keepRatio = true): Image
-    {
+    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);
 
         if ($type !== 'system') {
@@ -184,7 +190,7 @@ public function updateImageFile(Image $image, UploadedFile $file): void
      *
      * @throws Exception
      */
-    public function destroyImage(Image $image = null): void
+    public function destroyImage(?Image $image = null): void
     {
         if ($image) {
             $this->imageService->destroy($image);
diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php
@@ -31,8 +31,8 @@ public function saveNewFromUpload(
         UploadedFile $uploadedFile,
         string $type,
         int $uploadedTo = 0,
-        int $resizeWidth = null,
-        int $resizeHeight = null,
+        ?int $resizeWidth = null,
+        ?int $resizeHeight = null,
         bool $keepRatio = true,
         string $imageName = '',
     ): Image {
diff --git a/app/Users/Controllers/UserApiController.php b/app/Users/Controllers/UserApiController.php
@@ -33,7 +33,7 @@ public function __construct(UserRepo $userRepo)
         });
     }
 
-    protected function rules(int $userId = null): array
+    protected function rules(?int $userId = null): array
     {
         return [
             'create' => [
@@ -54,7 +54,7 @@ protected function rules(int $userId = null): array
                     'string',
                     'email',
                     'min:2',
-                    (new Unique('users', 'email'))->ignore($userId ?? null),
+                    (new Unique('users', 'email'))->ignore($userId),
                 ],
                 'external_auth_id' => ['string'],
                 'language'         => ['string', 'max:15', 'alpha_dash'],
diff --git a/app/Util/SsrUrlValidator.php b/app/Util/SsrUrlValidator.php
@@ -4,11 +4,16 @@
 
 use BookStack\Exceptions\HttpFetchException;
 
+/**
+ * Validate the host we're connecting to when making a server-side-request.
+ * Will use the given hosts config if given during construction otherwise
+ * will look to the app configured config.
+ */
 class SsrUrlValidator
 {
     protected string $config;
 
-    public function __construct(string $config = null)
+    public function __construct(?string $config = null)
     {
         $this->config = $config ?? config('app.ssr_hosts') ?? '';
     }
diff --git a/composer.json b/composer.json
@@ -18,7 +18,7 @@
         "ext-xml": "*",
         "ext-zip": "*",
         "bacon/bacon-qr-code": "^3.0",
-        "dompdf/dompdf": "^3.0",
+        "dompdf/dompdf": "^3.1",
         "guzzlehttp/guzzle": "^7.4",
         "intervention/image": "^3.5",
         "knplabs/knp-snappy": "^1.5",
diff --git a/composer.lock b/composer.lock
diff --git a/dev/docs/logical-theme-system.md b/dev/docs/logical-theme-system.md
@@ -49,6 +49,7 @@ This method allows you to register a custom social authentication driver within
 - string $driverName
 - array $config
 - string $socialiteHandler
+- callable|null $configureForRedirect = null
 
 **Example**
 
diff --git a/tests/Entity/PageEditorTest.php b/tests/Entity/PageEditorTest.php
@@ -191,20 +191,20 @@ public function test_editor_type_switch_options_show()
     {
         $resp = $this->asAdmin()->get($this->page->getUrl('/edit'));
         $editLink = $this->page->getUrl('/edit') . '?editor=';
-        $this->withHtml($resp)->assertElementContains("a[href=\"${editLink}markdown-clean\"]", '(Clean Content)');
-        $this->withHtml($resp)->assertElementContains("a[href=\"${editLink}markdown-stable\"]", '(Stable Content)');
-        $this->withHtml($resp)->assertElementContains("a[href=\"${editLink}wysiwyg2024\"]", '(In Alpha Testing)');
+        $this->withHtml($resp)->assertElementContains("a[href=\"{$editLink}markdown-clean\"]", '(Clean Content)');
+        $this->withHtml($resp)->assertElementContains("a[href=\"{$editLink}markdown-stable\"]", '(Stable Content)');
+        $this->withHtml($resp)->assertElementContains("a[href=\"{$editLink}wysiwyg2024\"]", '(In Alpha Testing)');
 
         $resp = $this->asAdmin()->get($this->page->getUrl('/edit?editor=markdown-stable'));
         $editLink = $this->page->getUrl('/edit') . '?editor=';
-        $this->withHtml($resp)->assertElementContains("a[href=\"${editLink}wysiwyg\"]", 'Switch to WYSIWYG Editor');
+        $this->withHtml($resp)->assertElementContains("a[href=\"{$editLink}wysiwyg\"]", 'Switch to WYSIWYG Editor');
     }
 
     public function test_editor_type_switch_options_dont_show_if_without_change_editor_permissions()
     {
         $resp = $this->asEditor()->get($this->page->getUrl('/edit'));
         $editLink = $this->page->getUrl('/edit') . '?editor=';
-        $this->withHtml($resp)->assertElementNotExists("a[href*=\"${editLink}\"]");
+        $this->withHtml($resp)->assertElementNotExists("a[href*=\"{$editLink}\"]");
     }
 
     public function test_page_editor_type_switch_does_not_work_without_change_editor_permissions()

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public function setVersion($ldapConnection, int $version): bool`
`54`	`54`	`*`
`55`	`55`	`* @return \LDAP\Result\|array\|false`
`56`	`56`	`*/`
`57`		`- public function search($ldapConnection, string $baseDn, string $filter, array $attributes = null)`
	`57`	`+ public function search($ldapConnection, string $baseDn, string $filter, array $attributes = [])`
`58`	`58`	`{`
`59`	`59`	`return ldap_search($ldapConnection, $baseDn, $filter, $attributes);`
`60`	`60`	`}`
`@@ -66,7 +66,7 @@ public function search($ldapConnection, string $baseDn, string $filter, array $a`
`66`	`66`	`*`
`67`	`67`	`* @return \LDAP\Result\|array\|false`
`68`	`68`	`*/`
`69`		`- public function read($ldapConnection, string $baseDn, string $filter, array $attributes = null)`
	`69`	`+ public function read($ldapConnection, string $baseDn, string $filter, array $attributes = [])`
`70`	`70`	`{`
`71`	`71`	`return ldap_read($ldapConnection, $baseDn, $filter, $attributes);`
`72`	`72`	`}`
`@@ -87,7 +87,7 @@ public function getEntries($ldapConnection, $ldapSearchResult): array\|false`
`87`	`87`	`*`
`88`	`88`	`* @param resource\|\LDAP\Connection $ldapConnection`
`89`	`89`	`*/`
`90`		`- public function searchAndGetEntries($ldapConnection, string $baseDn, string $filter, array $attributes = null): array\|false`
	`90`	`+ public function searchAndGetEntries($ldapConnection, string $baseDn, string $filter, array $attributes = []): array\|false`
`91`	`91`	`{`
`92`	`92`	`$search = $this->search($ldapConnection, $baseDn, $filter, $attributes);`
`93`	`93`
`@@ -99,7 +99,7 @@ public function searchAndGetEntries($ldapConnection, string $baseDn, string $fil`
`99`	`99`	`*`
`100`	`100`	`* @param resource\|\LDAP\Connection $ldapConnection`
`101`	`101`	`*/`
`102`		`- public function bind($ldapConnection, string $bindRdn = null, string $bindPassword = null): bool`
	`102`	`+ public function bind($ldapConnection, ?string $bindRdn = null, ?string $bindPassword = null): bool`
`103`	`103`	`{`
`104`	`104`	`return ldap_bind($ldapConnection, $bindRdn, $bindPassword);`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,9 +43,9 @@ function user(): User`
`43`	`43`	`* Check if the current user has a permission. If an ownable element`
`44`	`44`	`* is passed in the jointPermissions are checked against that particular item.`
`45`	`45`	`*/`
`46`		`-function userCan(string $permission, Model $ownable = null): bool`
	`46`	`+function userCan(string $permission, ?Model $ownable = null): bool`
`47`	`47`	`{`
`48`		`- if ($ownable === null) {`
	`48`	`+ if (is_null($ownable)) {`
`49`	`49`	`return user()->can($permission);`
`50`	`50`	`}`
`51`	`51`
`@@ -71,7 +71,7 @@ function userCanOnAny(string $action, string $entityClass = ''): bool`
`71`	`71`	`*`
`72`	`72`	`* @return mixed\|SettingService`
`73`	`73`	`*/`
`74`		`-function setting(string $key = null, $default = null)`
	`74`	`+function setting(?string $key = null, mixed $default = null): mixed`
`75`	`75`	`{`
`76`	`76`	`$settingService = app()->make(SettingService::class);`
`77`	`77`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function __construct(`
`41`	`41`	`*`
`42`	`42`	`* @throws Throwable`
`43`	`43`	`*/`
`44`		`- public function create(string $bookSlug, string $chapterSlug = null)`
	`44`	`+ public function create(string $bookSlug, ?string $chapterSlug = null)`
`45`	`45`	`{`
`46`	`46`	`if ($chapterSlug) {`
`47`	`47`	`$parent = $this->entityQueries->chapters->findVisibleBySlugsOrFail($bookSlug, $chapterSlug);`
`@@ -69,7 +69,7 @@ public function create(string $bookSlug, string $chapterSlug = null)`
`69`	`69`	`*`
`70`	`70`	`* @throws ValidationException`
`71`	`71`	`*/`
`72`		`- public function createAsGuest(Request $request, string $bookSlug, string $chapterSlug = null)`
	`72`	`+ public function createAsGuest(Request $request, string $bookSlug, ?string $chapterSlug = null)`
`73`	`73`	`{`
`74`	`74`	`$this->validate($request, [`
`75`	`75`	`'name' => ['required', 'string', 'max:255'],`
Original file line number	Diff line number	Diff line change
`@@ -18,15 +18,15 @@ public function __construct(`
`18`	`18`	`) {`
`19`	`19`	`}`
`20`	`20`
`21`		`- public function run(int $count, int $page, array $filterModels = null): Collection`
	`21`	`+ public function run(int $count, int $page, array $filterModels): Collection`
`22`	`22`	`{`
`23`	`23`	`$query = $this->permissions`
`24`	`24`	`->restrictEntityRelationQuery(View::query(), 'views', 'viewable_id', 'viewable_type')`
`25`	`25`	`->select('*', 'viewable_id', 'viewable_type', DB::raw('SUM(views) as view_count'))`
`26`	`26`	`->groupBy('viewable_id', 'viewable_type')`
`27`	`27`	`->orderBy('view_count', 'desc');`
`28`	`28`
`29`		`- if ($filterModels) {`
	`29`	`+ if (!empty($filterModels)) {`
`30`	`30`	`$query->whereIn('viewable_type', $this->entityProvider->getMorphClasses($filterModels));`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public function getNewDraftForCurrentUser(Page $page): PageRevision`
`46`	`46`	`/**`
`47`	`47`	`* Store a new revision in the system for the given page.`
`48`	`48`	`*/`
`49`		`- public function storeNewForPage(Page $page, string $summary = null): PageRevision`
	`49`	`+ public function storeNewForPage(Page $page, ?string $summary = null): PageRevision`
`50`	`50`	`{`
`51`	`51`	`$revision = new PageRevision();`
`52`	`52`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ public function readThemeActions(): void`
`93`	`93`	`/**`
`94`	`94`	`* @see SocialDriverManager::addSocialDriver`
`95`	`95`	`*/`
`96`		`- public function addSocialDriver(string $driverName, array $config, string $socialiteHandler, callable $configureForRedirect = null): void`
	`96`	`+ public function addSocialDriver(string $driverName, array $config, string $socialiteHandler, ?callable $configureForRedirect = null): void`
`97`	`97`	`{`
`98`	`98`	`$driverManager = app()->make(SocialDriverManager::class);`
`99`	`99`	`$driverManager->addSocialDriver($driverName, $config, $socialiteHandler, $configureForRedirect);`