Extracted icon helper, aligned container resolution

Also updated breadcrumb view composer to current standards.
Closes #4553
This commit is contained in:
Dan Brown 2023-09-16 18:25:08 +01:00
parent 54791c8627
commit b292cf7090
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
8 changed files with 54 additions and 56 deletions

View File

@ -71,7 +71,7 @@ trait ThrottlesLogins
*/ */
protected function limiter(): RateLimiter protected function limiter(): RateLimiter
{ {
return app(RateLimiter::class); return app()->make(RateLimiter::class);
} }
/** /**

View File

@ -78,14 +78,14 @@ class HomeController extends Controller
} }
if ($homepageOption === 'bookshelves') { if ($homepageOption === 'bookshelves') {
$shelves = app(BookshelfRepo::class)->getAllPaginated(18, $commonData['listOptions']->getSort(), $commonData['listOptions']->getOrder()); $shelves = app()->make(BookshelfRepo::class)->getAllPaginated(18, $commonData['listOptions']->getSort(), $commonData['listOptions']->getOrder());
$data = array_merge($commonData, ['shelves' => $shelves]); $data = array_merge($commonData, ['shelves' => $shelves]);
return view('home.shelves', $data); return view('home.shelves', $data);
} }
if ($homepageOption === 'books') { if ($homepageOption === 'books') {
$books = app(BookRepo::class)->getAllPaginated(18, $commonData['listOptions']->getSort(), $commonData['listOptions']->getOrder()); $books = app()->make(BookRepo::class)->getAllPaginated(18, $commonData['listOptions']->getSort(), $commonData['listOptions']->getOrder());
$data = array_merge($commonData, ['books' => $books]); $data = array_merge($commonData, ['books' => $books]);
return view('home.books', $data); return view('home.books', $data);

View File

@ -25,7 +25,7 @@ class ViewTweaksServiceProvider extends ServiceProvider
// Custom blade view directives // Custom blade view directives
Blade::directive('icon', function ($expression) { Blade::directive('icon', function ($expression) {
return "<?php echo icon($expression); ?>"; return "<?php echo (new \BookStack\Util\SvgIcon($expression))->toHtml(); ?>";
}); });
} }
} }

View File

@ -49,7 +49,7 @@ function userCan(string $permission, Model $ownable = null): bool
} }
// Check permission on ownable item // Check permission on ownable item
$permissions = app(PermissionApplicator::class); $permissions = app()->make(PermissionApplicator::class);
return $permissions->checkOwnableUserAccess($ownable, $permission); return $permissions->checkOwnableUserAccess($ownable, $permission);
} }
@ -60,7 +60,7 @@ function userCan(string $permission, Model $ownable = null): bool
*/ */
function userCanOnAny(string $action, string $entityClass = ''): bool function userCanOnAny(string $action, string $entityClass = ''): bool
{ {
$permissions = app(PermissionApplicator::class); $permissions = app()->make(PermissionApplicator::class);
return $permissions->checkUserHasEntityPermissionOnAny($action, $entityClass); return $permissions->checkUserHasEntityPermissionOnAny($action, $entityClass);
} }
@ -72,7 +72,7 @@ function userCanOnAny(string $action, string $entityClass = ''): bool
*/ */
function setting(string $key = null, $default = null) function setting(string $key = null, $default = null)
{ {
$settingService = resolve(SettingService::class); $settingService = app()->make(SettingService::class);
if (is_null($key)) { if (is_null($key)) {
return $settingService; return $settingService;
@ -97,39 +97,6 @@ function theme_path(string $path = ''): ?string
return base_path('themes/' . $theme . ($path ? DIRECTORY_SEPARATOR . $path : $path)); return base_path('themes/' . $theme . ($path ? DIRECTORY_SEPARATOR . $path : $path));
} }
/**
* Get fetch an SVG icon as a string.
* Checks for icons defined within a custom theme before defaulting back
* to the 'resources/assets/icons' folder.
*
* Returns an empty string if icon file not found.
*/
function icon(string $name, array $attrs = []): string
{
$attrs = array_merge([
'class' => 'svg-icon',
'data-icon' => $name,
'role' => 'presentation',
], $attrs);
$attrString = ' ';
foreach ($attrs as $attrName => $attr) {
$attrString .= $attrName . '="' . $attr . '" ';
}
$iconPath = resource_path('icons/' . $name . '.svg');
$themeIconPath = theme_path('icons/' . $name . '.svg');
if ($themeIconPath && file_exists($themeIconPath)) {
$iconPath = $themeIconPath;
} elseif (!file_exists($iconPath)) {
return '';
}
$fileContents = file_get_contents($iconPath);
return str_replace('<svg', '<svg' . $attrString, $fileContents);
}
/** /**
* Generate a URL with multiple parameters for sorting purposes. * Generate a URL with multiple parameters for sorting purposes.
* Works out the logic to set the correct sorting direction * Works out the logic to set the correct sorting direction

View File

@ -8,29 +8,21 @@ use Illuminate\View\View;
class BreadcrumbsViewComposer class BreadcrumbsViewComposer
{ {
protected $entityContextManager; public function __construct(
protected ShelfContext $shelfContext
/** ) {
* BreadcrumbsViewComposer constructor.
*
* @param ShelfContext $entityContextManager
*/
public function __construct(ShelfContext $entityContextManager)
{
$this->entityContextManager = $entityContextManager;
} }
/** /**
* Modify data when the view is composed. * Modify data when the view is composed.
*
* @param View $view
*/ */
public function compose(View $view) public function compose(View $view): void
{ {
$crumbs = $view->getData()['crumbs']; $crumbs = $view->getData()['crumbs'];
$firstCrumb = $crumbs[0] ?? null; $firstCrumb = $crumbs[0] ?? null;
if ($firstCrumb instanceof Book) { if ($firstCrumb instanceof Book) {
$shelf = $this->entityContextManager->getContextualShelfForBook($firstCrumb); $shelf = $this->shelfContext->getContextualShelfForBook($firstCrumb);
if ($shelf) { if ($shelf) {
array_unshift($crumbs, $shelf); array_unshift($crumbs, $shelf);
$view->with('crumbs', $crumbs); $view->with('crumbs', $crumbs);

View File

@ -197,7 +197,7 @@ class TrashCan
$page->allRevisions()->delete(); $page->allRevisions()->delete();
// Delete Attached Files // Delete Attached Files
$attachmentService = app(AttachmentService::class); $attachmentService = app()->make(AttachmentService::class);
foreach ($page->attachments as $attachment) { foreach ($page->attachments as $attachment) {
$attachmentService->deleteFile($attachment); $attachmentService->deleteFile($attachment);
} }

View File

@ -374,7 +374,7 @@ class User extends Model implements AuthenticatableContract, CanResetPasswordCon
*/ */
public function refreshSlug(): string public function refreshSlug(): string
{ {
$this->slug = app(SlugGenerator::class)->generate($this); $this->slug = app()->make(SlugGenerator::class)->generate($this);
return $this->slug; return $this->slug;
} }

39
app/Util/SvgIcon.php Normal file
View File

@ -0,0 +1,39 @@
<?php
namespace BookStack\Util;
class SvgIcon
{
public function __construct(
protected string $name,
protected array $attrs = []
) {
}
public function toHtml(): string
{
$attrs = array_merge([
'class' => 'svg-icon',
'data-icon' => $this->name,
'role' => 'presentation',
], $this->attrs);
$attrString = ' ';
foreach ($attrs as $attrName => $attr) {
$attrString .= $attrName . '="' . $attr . '" ';
}
$iconPath = resource_path('icons/' . $this->name . '.svg');
$themeIconPath = theme_path('icons/' . $this->name . '.svg');
if ($themeIconPath && file_exists($themeIconPath)) {
$iconPath = $themeIconPath;
} elseif (!file_exists($iconPath)) {
return '';
}
$fileContents = file_get_contents($iconPath);
return str_replace('<svg', '<svg' . $attrString, $fileContents);
}
}