Skip to content

Commit 2fe4698

Browse files
Added some minor documentation and updated changelog
Signed-off-by: Christian Wolf <[email protected]>
1 parent c9104b5 commit 2fe4698

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## [Unreleased]
22

3+
### Changed
4+
- Extracted user folder handling into its own helper class
5+
[#1007](https://github.com./nextcloud/cookbook/pull/1007) @christianlupus
6+
37
### Fixed
48
- Fix visual regression in edit mode to prevent overflow of breadcrumbs
59
[#989](https://github.com./nextcloud/cookbook/pull/989) @christianlupus

lib/Helper/UserConfigHelper.php

+9-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class UserConfigHelper {
2020
* @var IConfig
2121
*/
2222
private $config;
23-
23+
2424
/**
2525
* @var IL10N
2626
*/
@@ -164,6 +164,10 @@ public function setPrintImage(bool $value): void {
164164
*
165165
* If no folder is stored in the config yet, a default setting will be generated and saved.
166166
*
167+
* **Note:**
168+
* Do not use this method directly.
169+
* Instead use the methods of the UserFolderHelper class
170+
*
167171
* @return string The name of the folder within the users files
168172
* @throws UserNotLoggedInException if no user is logged in
169173
*/
@@ -182,6 +186,10 @@ public function getFolderName(): string {
182186
/**
183187
* Set the folder for the user's cookbook.
184188
*
189+
* **Note:**
190+
* Do not use this method directly.
191+
* Instead use the methods of the UserFolderHelper class
192+
*
185193
* @param string $value The name of the folder within the user's files
186194
* @return void
187195
* @throws UserNotLoggedInException if no user is logged in

0 commit comments

Comments
 (0)