-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add UserConfigChangedEvent to fire whenever a user config value is changed #42039
Open
akhil1508
wants to merge
3
commits into
nextcloud:master
Choose a base branch
from
Murena-SAS:dev/user-preference-event
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
/** | ||
* @copyright Copyright (c) 2023 Murena SAS <akhil.potukuchi.ext@murena.com> | ||
* | ||
* @author Murena SAS <akhil.potukuchi.ext@murena.com> | ||
* | ||
* @license GNU AGPL version 3 or any later version | ||
* | ||
* This program is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU Affero General Public License as | ||
* published by the Free Software Foundation, either version 3 of the | ||
* License, or (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU Affero General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Affero General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
* | ||
*/ | ||
|
||
namespace OCP\User\Events; | ||
|
||
use OCP\EventDispatcher\Event; | ||
|
||
/** | ||
* @since 31.0.0 | ||
*/ | ||
|
||
class UserConfigChangedEvent extends Event { | ||
private string $userId; | ||
private string $appId; | ||
private string $key; | ||
private mixed $value; | ||
private mixed $oldValue; | ||
|
||
/** | ||
* @since 31.0.0 | ||
*/ | ||
|
||
public function __construct(string $userId, | ||
string $appId, | ||
string $key, | ||
mixed $value, | ||
mixed $oldValue = null) { | ||
parent::__construct(); | ||
$this->userId = $userId; | ||
$this->appId = $appId; | ||
$this->key = $key; | ||
$this->value = $value; | ||
$this->oldValue = $oldValue; | ||
} | ||
|
||
/** | ||
* @return string | ||
* @since 31.0.0 | ||
*/ | ||
public function getUserId(): string { | ||
return $this->userId; | ||
} | ||
|
||
/** | ||
* @return string | ||
* @since 31.0.0 | ||
*/ | ||
public function getAppId(): string { | ||
return $this->appId; | ||
} | ||
|
||
/** | ||
* @return string | ||
* @since 31.0.0 | ||
*/ | ||
public function getKey(): string { | ||
return $this->key; | ||
} | ||
|
||
/** | ||
* @return mixed | ||
* @since 31.0.0 | ||
*/ | ||
public function getValue() { | ||
return $this->value; | ||
} | ||
|
||
/** | ||
* @return mixed | ||
* @since 31.0.0 | ||
*/ | ||
public function getOldValue() { | ||
return $this->oldValue; | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cannot use DI for this as it is used in
base.php
over hereThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is that the right link? The Allconfig constructor does not call setUserValue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@come-nc I believe I meant to say:
AllConfig
is instantiated inbase.php
asnew \OC\AllConfig(new \OC\SystemConfig(self::$config))
IEventListener $eventListener
in the constructor for DI in this class (the usual way), it could be problematic. I remember it causing errors when I first wrote this code, but maybe I should re-test? 🤔There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes please, the event listener is available early so I would be surprised if this is called even earlier. Maybe for login time 🤔
If some value change call do not trigger the event we need to document that.