X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/ddb7f33868ea499ab8f48a7062f145e8c0fbe02f..refs/pull/2393/head:/app/helpers.php diff --git a/app/helpers.php b/app/helpers.php index 6211f41be..935d4d8da 100644 --- a/app/helpers.php +++ b/app/helpers.php @@ -7,9 +7,6 @@ use BookStack\Settings\SettingService; /** * Get the path to a versioned file. - * - * @param string $file - * @return string * @throws Exception */ function versioned_asset(string $file = ''): string @@ -33,7 +30,6 @@ function versioned_asset(string $file = ''): string /** * Helper method to get the current User. * Defaults to public 'Guest' user if not logged in. - * @return User */ function user(): User { @@ -42,7 +38,6 @@ function user(): User /** * Check if current user is a signed in user. - * @return bool */ function signedInUser(): bool { @@ -51,7 +46,6 @@ function signedInUser(): bool /** * Check if the current user has general access. - * @return bool */ function hasAppAccess(): bool { @@ -59,12 +53,8 @@ function hasAppAccess(): bool } /** - * Check if the current user has a permission. - * If an ownable element is passed in the jointPermissions are checked against - * that particular item. - * @param string $permission - * @param Ownable $ownable - * @return bool + * 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(string $permission, Ownable $ownable = null): bool { @@ -80,9 +70,6 @@ function userCan(string $permission, Ownable $ownable = null): bool /** * Check if the current user has the given permission * on any item in the system. - * @param string $permission - * @param string|null $entityClass - * @return bool */ function userCanOnAny(string $permission, string $entityClass = null): bool { @@ -92,27 +79,26 @@ function userCanOnAny(string $permission, string $entityClass = null): bool /** * Helper to access system settings. - * @param string $key - * @param $default * @return bool|string|SettingService */ function setting(string $key = null, $default = false) { $settingService = resolve(SettingService::class); + if (is_null($key)) { return $settingService; } + return $settingService->get($key, $default); } /** * Get a path to a theme resource. - * @param string $path - * @return string */ function theme_path(string $path = ''): string { $theme = config('view.theme'); + if (!$theme) { return ''; } @@ -126,9 +112,6 @@ function theme_path(string $path = ''): string * to the 'resources/assets/icons' folder. * * Returns an empty string if icon file not found. - * @param $name - * @param array $attrs - * @return mixed */ function icon(string $name, array $attrs = []): string { @@ -144,6 +127,7 @@ function icon(string $name, array $attrs = []): string $iconPath = resource_path('icons/' . $name . '.svg'); $themeIconPath = theme_path('icons/' . $name . '.svg'); + if ($themeIconPath && file_exists($themeIconPath)) { $iconPath = $themeIconPath; } else if (!file_exists($iconPath)) { @@ -158,10 +142,6 @@ function icon(string $name, array $attrs = []): string * 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 string $path - * @param array $data - * @param array $overrideData - * @return string */ function sortUrl(string $path, array $data, array $overrideData = []): string { @@ -171,7 +151,7 @@ function sortUrl(string $path, array $data, array $overrideData = []): string // 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'; }