Skip to content

Commit 024924e

Browse files
ssddanbrownssddanbrown
committed
Applied another round of static analysis updates
1 parent 1bf59f4 commit 024924e

21 files changed

Lines changed: 96 additions & 57 deletions

‎app/Actions/ActivityService.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,10 @@ public function entityActivity(Entity $entity, int $count = 20, int $page = 1):
105105
$queryIds = [$entity->getMorphClass() => [$entity->id]];
106106

107107
if ($entity instanceof Book) {
108-
$queryIds[(new Chapter())->getMorphClass()] = $entity->chapters()->visible()->pluck('id');
108+
$queryIds[(new Chapter())->getMorphClass()] = $entity->chapters()->scopes('visible')->pluck('id');
109109
}
110110
if ($entity instanceof Book || $entity instanceof Chapter) {
111-
$queryIds[(new Page())->getMorphClass()] = $entity->pages()->visible()->pluck('id');
111+
$queryIds[(new Page())->getMorphClass()] = $entity->pages()->scopes('visible')->pluck('id');
112112
}
113113

114114
$query = $this->activity->newQuery();

‎app/Auth/Access/LdapService.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ public function validateUserCredentials(?array $ldapUserDetails, string $passwor
165165
* Bind the system user to the LDAP connection using the given credentials
166166
* otherwise anonymous access is attempted.
167167
*
168-
* @param $connection
168+
* @param resource $connection
169169
*
170170
* @throws LdapException
171171
*/

‎app/Auth/Access/Oidc/OidcJwtSigningKey.php‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,18 @@ public function __construct($jwkOrKeyPath)
4141
protected function loadFromPath(string $path)
4242
{
4343
try {
44-
$this->key = PublicKeyLoader::load(
44+
$key = PublicKeyLoader::load(
4545
file_get_contents($path)
46-
)->withPadding(RSA::SIGNATURE_PKCS1);
46+
);
4747
} catch (\Exception $exception) {
4848
throw new OidcInvalidKeyException("Failed to load key from file path with error: {$exception->getMessage()}");
4949
}
5050

51-
if (!($this->key instanceof RSA)) {
51+
if (!$key instanceof RSA) {
5252
throw new OidcInvalidKeyException('Key loaded from file path is not an RSA key as expected');
5353
}
54+
55+
$this->key = $key->withPadding(RSA::SIGNATURE_PKCS1);
5456
}
5557

5658
/**
@@ -81,14 +83,19 @@ protected function loadFromJwkArray(array $jwk)
8183
$n = strtr($jwk['n'] ?? '', '-_', '+/');
8284

8385
try {
84-
/** @var RSA $key */
85-
$this->key = PublicKeyLoader::load([
86+
$key = PublicKeyLoader::load([
8687
'e' => new BigInteger(base64_decode($jwk['e']), 256),
8788
'n' => new BigInteger(base64_decode($n), 256),
88-
])->withPadding(RSA::SIGNATURE_PKCS1);
89+
]);
8990
} catch (\Exception $exception) {
9091
throw new OidcInvalidKeyException("Failed to load key from JWK parameters with error: {$exception->getMessage()}");
9192
}
93+
94+
if (!$key instanceof RSA) {
95+
throw new OidcInvalidKeyException('Key loaded from file path is not an RSA key as expected');
96+
}
97+
98+
$this->key = $key->withPadding(RSA::SIGNATURE_PKCS1);
9299
}
93100

94101
/**

‎app/Auth/Access/SocialAuthService.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
use Laravel\Socialite\Contracts\Factory as Socialite;
1313
use Laravel\Socialite\Contracts\Provider;
1414
use Laravel\Socialite\Contracts\User as SocialUser;
15+
use Laravel\Socialite\Two\GoogleProvider;
1516
use SocialiteProviders\Manager\SocialiteWasCalled;
1617
use Symfony\Component\HttpFoundation\RedirectResponse;
1718

@@ -278,7 +279,7 @@ protected function getDriverForRedirect(string $driverName): Provider
278279
{
279280
$driver = $this->socialite->driver($driverName);
280281

281-
if ($driverName === 'google' && config('services.google.select_account')) {
282+
if ($driver instanceof GoogleProvider && config('services.google.select_account')) {
282283
$driver->with(['prompt' => 'select_account']);
283284
}
284285

‎app/Entities/Models/Book.php‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -79,53 +79,43 @@ public function coverImageTypeKey(): string
7979

8080
/**
8181
* Get all pages within this book.
82-
*
83-
* @return HasMany
8482
*/
85-
public function pages()
83+
public function pages(): HasMany
8684
{
8785
return $this->hasMany(Page::class);
8886
}
8987

9088
/**
9189
* Get the direct child pages of this book.
92-
*
93-
* @return HasMany
9490
*/
95-
public function directPages()
91+
public function directPages(): HasMany
9692
{
9793
return $this->pages()->where('chapter_id', '=', '0');
9894
}
9995

10096
/**
10197
* Get all chapters within this book.
102-
*
103-
* @return HasMany
10498
*/
105-
public function chapters()
99+
public function chapters(): HasMany
106100
{
107101
return $this->hasMany(Chapter::class);
108102
}
109103

110104
/**
111105
* Get the shelves this book is contained within.
112-
*
113-
* @return BelongsToMany
114106
*/
115-
public function shelves()
107+
public function shelves(): BelongsToMany
116108
{
117109
return $this->belongsToMany(Bookshelf::class, 'bookshelves_books', 'book_id', 'bookshelf_id');
118110
}
119111

120112
/**
121113
* Get the direct child items within this book.
122-
*
123-
* @return Collection
124114
*/
125115
public function getDirectChildren(): Collection
126116
{
127-
$pages = $this->directPages()->visible()->get();
128-
$chapters = $this->chapters()->visible()->get();
117+
$pages = $this->directPages()->scopes('visible')->get();
118+
$chapters = $this->chapters()->scopes('visible')->get();
129119

130120
return $pages->concat($chapters)->sortBy('priority')->sortByDesc('draft');
131121
}

‎app/Entities/Models/Bookshelf.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public function books()
3737
*/
3838
public function visibleBooks(): BelongsToMany
3939
{
40-
return $this->books()->visible();
40+
return $this->books()->scopes('visible');
4141
}
4242

4343
/**

‎app/Entities/Models/Chapter.php‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ class Chapter extends BookChild
2323

2424
/**
2525
* Get the pages that this chapter contains.
26+
* @return HasMany<Page>
2627
*/
2728
public function pages(string $dir = 'ASC'): HasMany
2829
{
@@ -50,7 +51,8 @@ public function getUrl(string $path = ''): string
5051
*/
5152
public function getVisiblePages(): Collection
5253
{
53-
return $this->pages()->visible()
54+
return $this->pages()
55+
->scopes('visible')
5456
->orderBy('draft', 'desc')
5557
->orderBy('priority', 'asc')
5658
->get();

‎app/Entities/Models/Entity.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,11 @@ public function matchesOrContains(self $entity): bool
121121
return true;
122122
}
123123

124-
if (($entity->isA('chapter') || $entity->isA('page')) && $this->isA('book')) {
124+
if (($entity instanceof BookChild) && $this instanceof Book) {
125125
return $entity->book_id === $this->id;
126126
}
127127

128-
if ($entity->isA('page') && $this->isA('chapter')) {
128+
if ($entity instanceof Page && $this instanceof Chapter) {
129129
return $entity->chapter_id === $this->id;
130130
}
131131

‎app/Entities/Models/PageRevision.php‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,8 @@ public function getUrl($path = null)
6363

6464
/**
6565
* Get the previous revision for the same page if existing.
66-
*
67-
* @return \BookStack\Entities\PageRevision|null
6866
*/
69-
public function getPrevious()
67+
public function getPrevious(): ?PageRevision
7068
{
7169
$id = static::newQuery()->where('page_id', '=', $this->page_id)
7270
->where('id', '<', $this->id)

‎app/Entities/Repos/PageRepo.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,10 @@ public function getBySlug(string $bookSlug, string $pageSlug): Page
6969
*/
7070
public function getByOldSlug(string $bookSlug, string $pageSlug): ?Page
7171
{
72+
/** @var ?PageRevision $revision */
7273
$revision = PageRevision::query()
7374
->whereHas('page', function (Builder $query) {
74-
$query->visible();
75+
$query->scopes('visible');
7576
})
7677
->where('slug', '=', $pageSlug)
7778
->where('type', '=', 'version')
@@ -80,7 +81,7 @@ public function getByOldSlug(string $bookSlug, string $pageSlug): ?Page
8081
->with('page')
8182
->first();
8283

83-
return $revision ? $revision->page : null;
84+
return $revision->page ?? null;
8485
}
8586

8687
/**

0 commit comments

Comments
 (0)