doc(dev): add xdebug informations

[bookstack] / app / helpers.php

diff --git a/app/helpers.php b/app/helpers.php
index daa747e7125a433d1c4571e2a5025cd63ac61d8f..9edc22c403d9b1a7859baaec7983a8ad14e898a4 100644 (file)
--- a/app/helpers.php
+++ b/app/helpers.php
@@ -1,15 +1,16 @@
 <?php
 
 <?php
 

-use BookStack\Ownable;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Auth\User;
+use BookStack\Model;
+use BookStack\Settings\SettingService;

 
 /**
  * Get the path to a versioned file.
  *
 
 /**
  * Get the path to a versioned file.
  *

- * @param  string $file
- * @return string

  * @throws Exception
  */
  * @throws Exception
  */

-function versioned_asset($file = '')
+function versioned_asset(string $file = ''): string

 {
     static $version = null;
 
 {
     static $version = null;
 


@@ -24,120 +25,124 @@ function versioned_asset($file = '')
     }
 
     $path = $file . '?version=' . urlencode($version) . $additional;
     }
 
     $path = $file . '?version=' . urlencode($version) . $additional;

-    return baseUrl($path);
+
+    return url($path);

 }
 
 /**
  * Helper method to get the current User.
  * Defaults to public 'Guest' user if not logged in.
 }
 
 /**
  * Helper method to get the current User.
  * Defaults to public 'Guest' user if not logged in.

- * @return \BookStack\User

  */
  */

-function user()
+function user(): User

 {
 {

-    return auth()->user() ?: \BookStack\User::getDefault();
+    return auth()->user() ?: User::getDefault();

 }
 
 /**
  * Check if current user is a signed in user.
 }
 
 /**
  * Check if current user is a signed in user.

- * @return bool

  */
  */

-function signedInUser()
+function signedInUser(): bool

 {
     return auth()->user() && !auth()->user()->isDefault();
 }
 
 /**
 {
     return auth()->user() && !auth()->user()->isDefault();
 }
 
 /**

- * Check if the current user has a permission.
- * If an ownable element is passed in the jointPermissions are checked against
- * that particular item.
- * @param $permission
- * @param Ownable $ownable
- * @return mixed
+ * Check if the current user has general access.
+ */
+function hasAppAccess(): bool
+{
+    return !auth()->guest() || setting('app-public');
+}
+
+/**
+ * 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($permission, Ownable $ownable = null)
+function userCan(string $permission, Model $ownable = null): bool

 {
     if ($ownable === null) {
         return user() && user()->can($permission);
     }
 
     // Check permission on ownable item
 {
     if ($ownable === null) {
         return user() && user()->can($permission);
     }
 
     // Check permission on ownable item

-    $permissionService = app(\BookStack\Services\PermissionService::class);
+    $permissionService = app(PermissionService::class);
+

     return $permissionService->checkOwnableUserAccess($ownable, $permission);
 }
 
     return $permissionService->checkOwnableUserAccess($ownable, $permission);
 }
 

+/**
+ * Check if the current user has the given permission
+ * on any item in the system.
+ */
+function userCanOnAny(string $permission, string $entityClass = null): bool
+{
+    $permissionService = app(PermissionService::class);
+
+    return $permissionService->checkUserHasPermissionOnAnything($permission, $entityClass);
+}
+

 /**
  * Helper to access system settings.
 /**
  * Helper to access system settings.

- * @param $key
- * @param bool $default
- * @return bool|string|\BookStack\Services\SettingService
+ *
+ * @return mixed|SettingService

  */
  */

-function setting($key = null, $default = false)
+function setting(string $key = null, $default = null)

 {
 {

-    $settingService = resolve(\BookStack\Services\SettingService::class);
+    $settingService = resolve(SettingService::class);
+

     if (is_null($key)) {
         return $settingService;
     }
     if (is_null($key)) {
         return $settingService;
     }

+

     return $settingService->get($key, $default);
 }
 
 /**
     return $settingService->get($key, $default);
 }
 
 /**

- * Helper to create url's relative to the applications root path.
- * @param string $path
- * @param bool $forceAppDomain
- * @return string
+ * 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 baseUrl($path, $forceAppDomain = false)
+function theme_path(string $path = ''): ?string

 {
 {

-    $isFullUrl = strpos($path, 'http') === 0;
-    if ($isFullUrl && !$forceAppDomain) {
-        return $path;
-    }
-    $path = trim($path, '/');
+    $theme = config('view.theme');

 
 

-    // Remove non-specified domain if forced and we have a domain
-    if ($isFullUrl && $forceAppDomain) {
-        $explodedPath = explode('/', $path);
-        $path = implode('/', array_splice($explodedPath, 3));
+    if (!$theme) {
+        return null;

     }
 
     }
 

-    // Return normal url path if not specified in config
-    if (config('app.url') === '') {
-        return url($path);
-    }
-
-    return rtrim(config('app.url'), '/') . '/' . $path;
+    return base_path('themes/' . $theme . ($path ? DIRECTORY_SEPARATOR . $path : $path));

 }
 
 /**
 }
 
 /**

- * Get an instance of the redirector.
- * Overrides the default laravel redirect helper.
- * Ensures it redirects even when the app is in a subdirectory.
+ * 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.

  *
  *

- * @param  string|null  $to
- * @param  int     $status
- * @param  array   $headers
- * @param  bool    $secure
- * @return \Illuminate\Routing\Redirector|\Illuminate\Http\RedirectResponse
+ * Returns an empty string if icon file not found.

  */
  */

-function redirect($to = null, $status = 302, $headers = [], $secure = null)
+function icon(string $name, array $attrs = []): string

 {
 {

-    if (is_null($to)) {
-        return app('redirect');
+    $attrs = array_merge([
+        'class'     => 'svg-icon',
+        'data-icon' => $name,
+        'role'      => 'presentation',
+    ], $attrs);
+    $attrString = ' ';
+    foreach ($attrs as $attrName => $attr) {
+        $attrString .= $attrName . '="' . $attr . '" ';

     }
 
     }
 

-    $to = baseUrl($to);
+    $iconPath = resource_path('icons/' . $name . '.svg');
+    $themeIconPath = theme_path('icons/' . $name . '.svg');

 
 

-    return app('redirect')->to($to, $status, $headers, $secure);
-}
-
-function icon($name, $attrs = [])
-{
-    $iconPath = resource_path('assets/icons/' . $name . '.svg');
-    $attrString = ' ';
-    foreach ($attrs as $attrName => $attr) {
-        $attrString .=  $attrName . '="' . $attr . '" ';
+    if ($themeIconPath && file_exists($themeIconPath)) {
+        $iconPath = $themeIconPath;
+    } elseif (!file_exists($iconPath)) {
+        return '';

     }
     }

+

     $fileContents = file_get_contents($iconPath);
     $fileContents = file_get_contents($iconPath);

+

     return  str_replace('<svg', '<svg' . $attrString, $fileContents);
 }
 
     return  str_replace('<svg', '<svg' . $attrString, $fileContents);
 }
 


@@ -145,12 +150,8 @@ function icon($name, $attrs = [])
  * Generate a url with multiple parameters for sorting purposes.
  * Works out the logic to set the correct sorting direction
  * Discards empty parameters and allows overriding.
  * Generate a url with multiple parameters for sorting purposes.
  * Works out the logic to set the correct sorting direction
  * Discards empty parameters and allows overriding.

- * @param $path
- * @param array $data
- * @param array $overrideData
- * @return string

  */
  */

-function sortUrl($path, $data, $overrideData = [])
+function sortUrl(string $path, array $data, array $overrideData = []): string

 {
     $queryStringSections = [];
     $queryData = array_merge($data, $overrideData);
 {
     $queryStringSections = [];
     $queryData = array_merge($data, $overrideData);


@@ -158,7 +159,7 @@ function sortUrl($path, $data, $overrideData = [])
     // Change sorting direction is already sorted on current attribute
     if (isset($overrideData['sort']) && $overrideData['sort'] === $data['sort']) {
         $queryData['order'] = ($data['order'] === 'asc') ? 'desc' : 'asc';
     // Change sorting direction is already sorted on current attribute
     if (isset($overrideData['sort']) && $overrideData['sort'] === $data['sort']) {
         $queryData['order'] = ($data['order'] === 'asc') ? 'desc' : 'asc';

-    } else {
+    } elseif (isset($overrideData['sort'])) {

         $queryData['order'] = 'asc';
     }
 
         $queryData['order'] = 'asc';
     }
 


@@ -174,5 +175,5 @@ function sortUrl($path, $data, $overrideData = [])
         return $path;
     }
 
         return $path;
     }
 

-    return baseUrl($path . '?' . implode('&', $queryStringSections));
+    return url($path . '?' . implode('&', $queryStringSections));

 }
 }