Added testing for our request method overrides

[bookstack] / app / helpers.php

diff --git a/app/helpers.php b/app/helpers.php
index c090bfd055acc400e1ad4c46e7059b6c19820f60..9edc22c403d9b1a7859baaec7983a8ad14e898a4 100644 (file)
--- a/app/helpers.php
+++ b/app/helpers.php
@@ -7,6 +7,7 @@ use BookStack\Settings\SettingService;
 
 /**
  * Get the path to a versioned file.
+ *
  * @throws Exception
  */
 function versioned_asset(string $file = ''): string
@@ -24,6 +25,7 @@ function versioned_asset(string $file = ''): string
     }
 
     $path = $file . '?version=' . urlencode($version) . $additional;
+
     return url($path);
 }
 
@@ -64,6 +66,7 @@ function userCan(string $permission, Model $ownable = null): bool
 
     // Check permission on ownable item
     $permissionService = app(PermissionService::class);
+
     return $permissionService->checkOwnableUserAccess($ownable, $permission);
 }
 
@@ -74,14 +77,16 @@ function userCan(string $permission, Model $ownable = null): bool
 function userCanOnAny(string $permission, string $entityClass = null): bool
 {
     $permissionService = app(PermissionService::class);
+
     return $permissionService->checkUserHasPermissionOnAnything($permission, $entityClass);
 }
 
 /**
  * Helper to access system settings.
- * @return bool|string|SettingService
+ *
+ * @return mixed|SettingService
  */
-function setting(string $key = null, $default = false)
+function setting(string $key = null, $default = null)
 {
     $settingService = resolve(SettingService::class);
 
@@ -94,16 +99,18 @@ function setting(string $key = null, $default = false)
 
 /**
  * Get a path to a theme resource.
+ * Returns null if a theme is not configured and
+ * therefore a full path is not available for use.
  */
-function theme_path(string $path = ''): string
+function theme_path(string $path = ''): ?string
 {
     $theme = config('view.theme');
 
     if (!$theme) {
-        return '';
+        return null;
     }
 
-    return base_path('themes/' . $theme .($path ? DIRECTORY_SEPARATOR.$path : $path));
+    return base_path('themes/' . $theme . ($path ? DIRECTORY_SEPARATOR . $path : $path));
 }
 
 /**
@@ -122,7 +129,7 @@ function icon(string $name, array $attrs = []): string
     ], $attrs);
     $attrString = ' ';
     foreach ($attrs as $attrName => $attr) {
-        $attrString .=  $attrName . '="' . $attr . '" ';
+        $attrString .= $attrName . '="' . $attr . '" ';
     }
 
     $iconPath = resource_path('icons/' . $name . '.svg');
@@ -130,11 +137,12 @@ function icon(string $name, array $attrs = []): string
 
     if ($themeIconPath && file_exists($themeIconPath)) {
         $iconPath = $themeIconPath;
-    } else if (!file_exists($iconPath)) {
+    } elseif (!file_exists($iconPath)) {
         return '';
     }
 
     $fileContents = file_get_contents($iconPath);
+
     return  str_replace('<svg', '<svg' . $attrString, $fileContents);
 }