NOW MANAGED ON CODEBERG
Maintenance: Addressed a range of phpstan level 3 issues
Dan Browne05ec7da3610
diff --git a/app/Access/ExternalBaseUserProvider.php b/app/Access/ExternalBaseUserProvider.phpindex 2b5ddfbf3..2165fd459 100644--- a/app/Access/ExternalBaseUserProvider.php+++ b/app/Access/ExternalBaseUserProvider.php@@ -2,33 +2,18 @@namespace BookStack\Access;+use BookStack\Users\Models\User;use Illuminate\Contracts\Auth\Authenticatable;use Illuminate\Contracts\Auth\UserProvider;-use Illuminate\Database\Eloquent\Model;class ExternalBaseUserProvider implements UserProvider{- public function __construct(- protected string $model- ) {- }-- /**- * Create a new instance of the model.- */- public function createModel(): Model- {- $class = '\\' . ltrim($this->model, '\\');-- return new $class();- }-/*** Retrieve a user by their unique identifier.*/public function retrieveById(mixed $identifier): ?Authenticatable{- return $this->createModel()->newQuery()->find($identifier);+ return User::query()->find($identifier);}/**@@ -59,10 +44,7 @@ class ExternalBaseUserProvider implements UserProvider*/public function retrieveByCredentials(array $credentials): ?Authenticatable{- // Search current user base by looking up a uid- $model = $this->createModel();-- return $model->newQuery()+ return User::query()->where('external_auth_id', $credentials['external_auth_id'])->first();}diff --git a/app/Access/Guards/ExternalBaseSessionGuard.php b/app/Access/Guards/ExternalBaseSessionGuard.phpindex 2d15422a5..899e93c36 100644--- a/app/Access/Guards/ExternalBaseSessionGuard.php+++ b/app/Access/Guards/ExternalBaseSessionGuard.php@@ -4,7 +4,7 @@ namespace BookStack\Access\Guards;use BookStack\Access\RegistrationService;use Illuminate\Auth\GuardHelpers;-use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;+use Illuminate\Contracts\Auth\Authenticatable;use Illuminate\Contracts\Auth\StatefulGuard;use Illuminate\Contracts\Auth\UserProvider;use Illuminate\Contracts\Session\Session;@@ -24,43 +24,31 @@ class ExternalBaseSessionGuard implements StatefulGuard* The name of the Guard. Typically "session".** Corresponds to guard name in authentication configuration.- *- * @var string*/- protected $name;+ protected readonly string $name;/*** The user we last attempted to retrieve.- *- * @var \Illuminate\Contracts\Auth\Authenticatable*/- protected $lastAttempted;+ protected Authenticatable $lastAttempted;/*** The session used by the guard.- *- * @var \Illuminate\Contracts\Session\Session*/- protected $session;+ protected Session $session;/*** Indicates if the logout method has been called.- *- * @var bool*/- protected $loggedOut = false;+ protected bool $loggedOut = false;/*** Service to handle common registration actions.- *- * @var RegistrationService*/- protected $registrationService;+ protected RegistrationService $registrationService;/*** Create a new authentication guard.- *- * @return void*/public function __construct(string $name, UserProvider $provider, Session $session, RegistrationService $registrationService){@@ -72,13 +60,11 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Get the currently authenticated user.- *- * @return \Illuminate\Contracts\Auth\Authenticatable|null*/- public function user()+ public function user(): Authenticatable|null{if ($this->loggedOut) {- return;+ return null;}// If we've already retrieved the user for the current request we can just@@ -101,13 +87,11 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Get the ID for the currently authenticated user.- *- * @return int|null*/- public function id()+ public function id(): int|null{if ($this->loggedOut) {- return;+ return null;}return $this->user()@@ -117,12 +101,8 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Log a user into the application without sessions or cookies.- *- * @param array $credentials- *- * @return bool*/- public function once(array $credentials = [])+ public function once(array $credentials = []): bool{if ($this->validate($credentials)) {$this->setUser($this->lastAttempted);@@ -135,12 +115,8 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Log the given user ID into the application without sessions or cookies.- *- * @param mixed $id- *- * @return \Illuminate\Contracts\Auth\Authenticatable|false*/- public function onceUsingId($id)+ public function onceUsingId($id): Authenticatable|false{if (!is_null($user = $this->provider->retrieveById($id))) {$this->setUser($user);@@ -153,38 +129,26 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Validate a user's credentials.- *- * @param array $credentials- *- * @return bool*/- public function validate(array $credentials = [])+ public function validate(array $credentials = []): bool{return false;}/*** Attempt to authenticate a user using the given credentials.- *- * @param array $credentials- * @param bool $remember- *- * @return bool+ * @param bool $remember*/- public function attempt(array $credentials = [], $remember = false)+ public function attempt(array $credentials = [], $remember = false): bool{return false;}/*** Log the given user ID into the application.- *- * @param mixed $id* @param bool $remember- *- * @return \Illuminate\Contracts\Auth\Authenticatable|false*/- public function loginUsingId($id, $remember = false)+ public function loginUsingId(mixed $id, $remember = false): Authenticatable|false{// Always return false as to disable this method,// Logins should route through LoginService.@@ -194,12 +158,9 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Log a user into the application.*- * @param \Illuminate\Contracts\Auth\Authenticatable $user- * @param bool $remember- *- * @return void+ * @param bool $remember*/- public function login(AuthenticatableContract $user, $remember = false)+ public function login(Authenticatable $user, $remember = false): void{$this->updateSession($user->getAuthIdentifier());@@ -208,12 +169,8 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Update the session with the given ID.- *- * @param string $id- *- * @return void*/- protected function updateSession($id)+ protected function updateSession(string|int $id): void{$this->session->put($this->getName(), $id);@@ -222,10 +179,8 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Log the user out of the application.- *- * @return void*/- public function logout()+ public function logout(): void{$this->clearUserDataFromStorage();@@ -239,62 +194,48 @@ class ExternalBaseSessionGuard implements StatefulGuard/*** Remove the user data from the session and cookies.- *- * @return void*/- protected function clearUserDataFromStorage()+ protected function clearUserDataFromStorage(): void{$this->session->remove($this->getName());}/*** Get the last user we attempted to authenticate.- *- * @return \Illuminate\Contracts\Auth\Authenticatable*/- public function getLastAttempted()+ public function getLastAttempted(): Authenticatable{return $this->lastAttempted;}/*** Get a unique identifier for the auth session value.- *- * @return string*/- public function getName()+ public function getName(): string{return 'login_' . $this->name . '_' . sha1(static::class);}/*** Determine if the user was authenticated via "remember me" cookie.- *- * @return bool*/- public function viaRemember()+ public function viaRemember(): bool{return false;}/*** Return the currently cached user.- *- * @return \Illuminate\Contracts\Auth\Authenticatable|null*/- public function getUser()+ public function getUser(): Authenticatable|null{return $this->user;}/*** Set the current user.- *- * @param \Illuminate\Contracts\Auth\Authenticatable $user- *- * @return $this*/- public function setUser(AuthenticatableContract $user)+ public function setUser(Authenticatable $user): self{$this->user = $user;diff --git a/app/Activity/Models/Comment.php b/app/Activity/Models/Comment.phpindex 6b05a9bab..0cb83d61e 100644--- a/app/Activity/Models/Comment.php+++ b/app/Activity/Models/Comment.php@@ -39,7 +39,7 @@ class Comment extends Model implements Loggable, OwnableInterface/*** Get the parent comment this is in reply to (if existing).- * @return BelongsTo<Comment, Comment>+ * @return BelongsTo<Comment, $this>*/public function parent(): BelongsTo{diff --git a/app/App/Providers/AuthServiceProvider.php b/app/App/Providers/AuthServiceProvider.phpindex 23c339079..6a8162521 100644--- a/app/App/Providers/AuthServiceProvider.php+++ b/app/App/Providers/AuthServiceProvider.php@@ -59,8 +59,8 @@ class AuthServiceProvider extends ServiceProvider*/public function register(): void{- Auth::provider('external-users', function ($app, array $config) {- return new ExternalBaseUserProvider($config['model']);+ Auth::provider('external-users', function () {+ return new ExternalBaseUserProvider();});// Bind and provide the default system user as a singleton to the app instance when needed.diff --git a/app/App/Providers/EventServiceProvider.php b/app/App/Providers/EventServiceProvider.phpindex 34ab7cfef..60e78efe0 100644--- a/app/App/Providers/EventServiceProvider.php+++ b/app/App/Providers/EventServiceProvider.php@@ -15,7 +15,7 @@ class EventServiceProvider extends ServiceProvider/*** The event listener mappings for the application.*- * @var array<class-string, array<int, class-string>>+ * @var array<class-string, array<int, string>>*/protected $listen = [SocialiteWasCalled::class => [diff --git a/app/Entities/Controllers/PageRevisionController.php b/app/Entities/Controllers/PageRevisionController.phpindex 4985c39f3..c43eea08b 100644--- a/app/Entities/Controllers/PageRevisionController.php+++ b/app/Entities/Controllers/PageRevisionController.php@@ -98,7 +98,7 @@ class PageRevisionController extends Controllerthrow new NotFoundException();}- $prev = $revision->getPrevious();+ $prev = $revision->getPreviousRevision();$prevContent = $prev->html ?? '';$diff = Diff::excecute($prevContent, $revision->html);diff --git a/app/Entities/Models/PageRevision.php b/app/Entities/Models/PageRevision.phpindex 10ff6d901..1a6c980e1 100644--- a/app/Entities/Models/PageRevision.php+++ b/app/Entities/Models/PageRevision.php@@ -60,7 +60,7 @@ class PageRevision extends Model implements Loggable/*** Get the previous revision for the same page if existing.*/- public function getPrevious(): ?PageRevision+ public function getPreviousRevision(): ?PageRevision{$id = static::newQuery()->where('page_id', '=', $this->page_id)->where('id', '<', $this->id)diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.phpindex 61e126327..b8c3fa192 100644--- a/app/Exceptions/Handler.php+++ b/app/Exceptions/Handler.php@@ -94,7 +94,7 @@ class Handler extends ExceptionHandler* If the callable returns a response, this response will be returned* to the request upon error.*/- public function prepareForOutOfMemory(callable $onOutOfMemory)+ public function prepareForOutOfMemory(callable $onOutOfMemory): void{$this->onOutOfMemory = $onOutOfMemory;}@@ -102,7 +102,7 @@ class Handler extends ExceptionHandler/*** Forget the current out of memory handler, if existing.*/- public function forgetOutOfMemoryHandler()+ public function forgetOutOfMemoryHandler(): void{$this->onOutOfMemory = null;}diff --git a/app/Exports/ImportRepo.php b/app/Exports/ImportRepo.phpindex e030a88d2..896af903a 100644--- a/app/Exports/ImportRepo.php+++ b/app/Exports/ImportRepo.php@@ -39,6 +39,9 @@ class ImportReporeturn $this->queryVisible()->get();}+ /**+ * @return Builder<Import>+ */public function queryVisible(): Builder{$query = Import::query();diff --git a/app/Exports/ZipExports/Models/ZipExportAttachment.php b/app/Exports/ZipExports/Models/ZipExportAttachment.phpindex 4f5b2f236..97995738f 100644--- a/app/Exports/ZipExports/Models/ZipExportAttachment.php+++ b/app/Exports/ZipExports/Models/ZipExportAttachment.php@@ -6,7 +6,7 @@ use BookStack\Exports\ZipExports\ZipExportFiles;use BookStack\Exports\ZipExports\ZipValidationHelper;use BookStack\Uploads\Attachment;-class ZipExportAttachment extends ZipExportModel+final class ZipExportAttachment extends ZipExportModel{public ?int $id = null;public string $name;@@ -52,9 +52,9 @@ class ZipExportAttachment extends ZipExportModelreturn $context->validateData($data, $rules);}- public static function fromArray(array $data): self+ public static function fromArray(array $data): static{- $model = new self();+ $model = new static();$model->id = $data['id'] ?? null;$model->name = $data['name'];diff --git a/app/Exports/ZipExports/Models/ZipExportBook.php b/app/Exports/ZipExports/Models/ZipExportBook.phpindex 39176ded4..6c51ea337 100644--- a/app/Exports/ZipExports/Models/ZipExportBook.php+++ b/app/Exports/ZipExports/Models/ZipExportBook.php@@ -8,7 +8,7 @@ use BookStack\Entities\Models\Page;use BookStack\Exports\ZipExports\ZipExportFiles;use BookStack\Exports\ZipExports\ZipValidationHelper;-class ZipExportBook extends ZipExportModel+final class ZipExportBook extends ZipExportModel{public ?int $id = null;public string $name;@@ -101,9 +101,9 @@ class ZipExportBook extends ZipExportModelreturn $errors;}- public static function fromArray(array $data): self+ public static function fromArray(array $data): static{- $model = new self();+ $model = new static();$model->id = $data['id'] ?? null;$model->name = $data['name'];diff --git a/app/Exports/ZipExports/Models/ZipExportChapter.php b/app/Exports/ZipExports/Models/ZipExportChapter.phpindex bf2dc78f8..260191a3e 100644--- a/app/Exports/ZipExports/Models/ZipExportChapter.php+++ b/app/Exports/ZipExports/Models/ZipExportChapter.php@@ -7,7 +7,7 @@ use BookStack\Entities\Models\Page;use BookStack\Exports\ZipExports\ZipExportFiles;use BookStack\Exports\ZipExports\ZipValidationHelper;-class ZipExportChapter extends ZipExportModel+final class ZipExportChapter extends ZipExportModel{public ?int $id = null;public string $name;@@ -79,9 +79,9 @@ class ZipExportChapter extends ZipExportModelreturn $errors;}- public static function fromArray(array $data): self+ public static function fromArray(array $data): static{- $model = new self();+ $model = new static();$model->id = $data['id'] ?? null;$model->name = $data['name'];diff --git a/app/Exports/ZipExports/Models/ZipExportImage.php b/app/Exports/ZipExports/Models/ZipExportImage.phpindex e0e7d1198..4c71af0c3 100644--- a/app/Exports/ZipExports/Models/ZipExportImage.php+++ b/app/Exports/ZipExports/Models/ZipExportImage.php@@ -7,7 +7,7 @@ use BookStack\Exports\ZipExports\ZipValidationHelper;use BookStack\Uploads\Image;use Illuminate\Validation\Rule;-class ZipExportImage extends ZipExportModel+final class ZipExportImage extends ZipExportModel{public ?int $id = null;public string $name;@@ -43,9 +43,9 @@ class ZipExportImage extends ZipExportModelreturn $context->validateData($data, $rules);}- public static function fromArray(array $data): self+ public static function fromArray(array $data): static{- $model = new self();+ $model = new static();$model->id = $data['id'] ?? null;$model->name = $data['name'];diff --git a/app/Exports/ZipExports/Models/ZipExportModel.php b/app/Exports/ZipExports/Models/ZipExportModel.phpindex d3a8c3567..38001c628 100644--- a/app/Exports/ZipExports/Models/ZipExportModel.php+++ b/app/Exports/ZipExports/Models/ZipExportModel.php@@ -30,12 +30,12 @@ abstract class ZipExportModel implements JsonSerializable/*** Decode the array of data into this export model.*/- abstract public static function fromArray(array $data): self;+ abstract public static function fromArray(array $data): static;/*** Decode an array of array data into an array of export models.* @param array[] $data- * @return self[]+ * @return static[]*/public static function fromManyArray(array $data): array{diff --git a/app/Exports/ZipExports/Models/ZipExportPage.php b/app/Exports/ZipExports/Models/ZipExportPage.phpindex 097443df0..6de7f9446 100644--- a/app/Exports/ZipExports/Models/ZipExportPage.php+++ b/app/Exports/ZipExports/Models/ZipExportPage.php@@ -7,7 +7,7 @@ use BookStack\Entities\Tools\PageContent;use BookStack\Exports\ZipExports\ZipExportFiles;use BookStack\Exports\ZipExports\ZipValidationHelper;-class ZipExportPage extends ZipExportModel+final class ZipExportPage extends ZipExportModel{public ?int $id = null;public string $name;@@ -86,9 +86,9 @@ class ZipExportPage extends ZipExportModelreturn $errors;}- public static function fromArray(array $data): self+ public static function fromArray(array $data): static{- $model = new self();+ $model = new static();$model->id = $data['id'] ?? null;$model->name = $data['name'];diff --git a/app/Exports/ZipExports/Models/ZipExportTag.php b/app/Exports/ZipExports/Models/ZipExportTag.phpindex 6b4720fca..8ac7f3c4d 100644--- a/app/Exports/ZipExports/Models/ZipExportTag.php+++ b/app/Exports/ZipExports/Models/ZipExportTag.php@@ -5,7 +5,7 @@ namespace BookStack\Exports\ZipExports\Models;use BookStack\Activity\Models\Tag;use BookStack\Exports\ZipExports\ZipValidationHelper;-class ZipExportTag extends ZipExportModel+final class ZipExportTag extends ZipExportModel{public string $name;public ?string $value = null;@@ -39,9 +39,9 @@ class ZipExportTag extends ZipExportModelreturn $context->validateData($data, $rules);}- public static function fromArray(array $data): self+ public static function fromArray(array $data): static{- $model = new self();+ $model = new static();$model->name = $data['name'];$model->value = $data['value'] ?? null;diff --git a/app/Http/Kernel.php b/app/Http/Kernel.phpindex 30714e2ac..00bf8cbe1 100644--- a/app/Http/Kernel.php+++ b/app/Http/Kernel.php@@ -9,6 +9,8 @@ class Kernel extends HttpKernel/*** The application's global HTTP middleware stack.* These middleware are run during every request to your application.+ *+ * @var list<class-string>*/protected $middleware = [\BookStack\Http\Middleware\PreventRequestsDuringMaintenance::class,@@ -21,7 +23,7 @@ class Kernel extends HttpKernel/*** The application's route middleware groups.*- * @var array+ * @var array<string, array<int, class-string>>*/protected $middlewareGroups = ['web' => [@@ -47,7 +49,7 @@ class Kernel extends HttpKernel/*** The application's middleware aliases.*- * @var array+ * @var array<string, class-string>*/protected $middlewareAliases = ['auth' => \BookStack\Http\Middleware\Authenticate::class,diff --git a/app/Http/Middleware/EncryptCookies.php b/app/Http/Middleware/EncryptCookies.phpindex 484c15ae8..2d7d5d9d4 100644--- a/app/Http/Middleware/EncryptCookies.php+++ b/app/Http/Middleware/EncryptCookies.php@@ -9,7 +9,7 @@ class EncryptCookies extends Middleware/*** The names of the cookies that should not be encrypted.*- * @var array+ * @var array<int, string>*/protected $except = [//diff --git a/app/Http/Middleware/PreventRequestsDuringMaintenance.php b/app/Http/Middleware/PreventRequestsDuringMaintenance.phpindex dfb9592e1..c1a02c8cc 100644--- a/app/Http/Middleware/PreventRequestsDuringMaintenance.php+++ b/app/Http/Middleware/PreventRequestsDuringMaintenance.php@@ -9,7 +9,7 @@ class PreventRequestsDuringMaintenance extends Middleware/*** The URIs that should be reachable while maintenance mode is enabled.*- * @var array+ * @var array<int, string>*/protected $except = [//diff --git a/app/Http/Middleware/TrimStrings.php b/app/Http/Middleware/TrimStrings.phpindex cbdc88fb9..ec5725d67 100644--- a/app/Http/Middleware/TrimStrings.php+++ b/app/Http/Middleware/TrimStrings.php@@ -9,7 +9,7 @@ class TrimStrings extends Middleware/*** The names of the attributes that should not be trimmed.*- * @var array+ * @var array<int, string>*/protected $except = ['password',diff --git a/app/Http/Middleware/TrustProxies.php b/app/Http/Middleware/TrustProxies.phpindex 0fe0247b8..ecf6cb18a 100644--- a/app/Http/Middleware/TrustProxies.php+++ b/app/Http/Middleware/TrustProxies.php@@ -11,7 +11,7 @@ class TrustProxies extends Middleware/*** The trusted proxies for this application.*- * @var array+ * @var array<int,string>|string|null*/protected $proxies;diff --git a/app/Http/Middleware/VerifyCsrfToken.php b/app/Http/Middleware/VerifyCsrfToken.phpindex 804a22bc0..7c8689b8b 100644--- a/app/Http/Middleware/VerifyCsrfToken.php+++ b/app/Http/Middleware/VerifyCsrfToken.php@@ -16,7 +16,7 @@ class VerifyCsrfToken extends Middleware/*** The URIs that should be excluded from CSRF verification.*- * @var array+ * @var array<int, string>*/protected $except = ['saml2/*',diff --git a/app/Search/SearchOptionSet.php b/app/Search/SearchOptionSet.phpindex bd5e5a5b2..844d145e6 100644--- a/app/Search/SearchOptionSet.php+++ b/app/Search/SearchOptionSet.php@@ -14,6 +14,9 @@ class SearchOptionSet*/protected array $options = [];+ /**+ * @param T[] $options+ */public function __construct(array $options = []){$this->options = $options;diff --git a/app/Search/SearchRunner.php b/app/Search/SearchRunner.phpindex 9716f8053..c14d1c642 100644--- a/app/Search/SearchRunner.php+++ b/app/Search/SearchRunner.php@@ -285,7 +285,7 @@ class SearchRunner** @param array<string, int> $termCounts*- * @return array<string, int>+ * @return array<string, float>*/protected function rawTermCountsToAdjustments(array $termCounts): array{diff --git a/app/Users/Models/User.php b/app/Users/Models/User.phpindex b6989ce2d..f83e12088 100644--- a/app/Users/Models/User.php+++ b/app/Users/Models/User.php@@ -26,6 +26,7 @@ use Illuminate\Database\Eloquent\Factories\HasFactory;use Illuminate\Database\Eloquent\Relations\BelongsTo;use Illuminate\Database\Eloquent\Relations\BelongsToMany;use Illuminate\Database\Eloquent\Relations\HasMany;+use Illuminate\Database\Eloquent\Relations\Relation;use Illuminate\Notifications\Notifiable;use Illuminate\Support\Collection;@@ -64,7 +65,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon/*** The attributes that are mass assignable.*- * @var array+ * @var list<string>*/protected $fillable = ['name', 'email'];@@ -73,7 +74,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon/*** The attributes excluded from the model's JSON form.*- * @var array+ * @var list<string>*/protected $hidden = ['password', 'remember_token', 'system_name', 'email_confirmed', 'external_auth_id', 'email',@@ -118,14 +119,10 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon/*** The roles that belong to the user.*- * @return BelongsToMany+ * @return BelongsToMany<Role, $this>*/- public function roles()+ public function roles(): BelongsToMany{- if ($this->id === 0) {- return;- }-return $this->belongsToMany(Role::class);}diff --git a/app/Util/OutOfMemoryHandler.php b/app/Util/OutOfMemoryHandler.phpindex 88e9581f4..6632d22a5 100644--- a/app/Util/OutOfMemoryHandler.php+++ b/app/Util/OutOfMemoryHandler.php@@ -42,7 +42,7 @@ class OutOfMemoryHandler}/**- * Forget the handler so no action is taken place on out of memory.+ * Forget the handler, so no action is taken place on out of memory.*/public function forget(): void{@@ -53,6 +53,11 @@ class OutOfMemoryHandlerprotected function getHandler(): Handler{+ /**+ * We want to resolve our specific BookStack handling via the set app handler+ * singleton, but phpstan will only infer based on the interface.+ * @phpstan-ignore return.type+ */return app()->make(ExceptionHandler::class);}}