@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 12 |
32 | 32 | */ |
33 | 33 | interface IStore { |
34 | - /** |
|
35 | - * Get login credentials of the currently logged in user |
|
36 | - * |
|
37 | - * @since 12 |
|
38 | - * |
|
39 | - * @throws CredentialsUnavailableException |
|
40 | - * @return ICredentials the login credentials of the current user |
|
41 | - */ |
|
42 | - public function getLoginCredentials(): ICredentials; |
|
34 | + /** |
|
35 | + * Get login credentials of the currently logged in user |
|
36 | + * |
|
37 | + * @since 12 |
|
38 | + * |
|
39 | + * @throws CredentialsUnavailableException |
|
40 | + * @return ICredentials the login credentials of the current user |
|
41 | + */ |
|
42 | + public function getLoginCredentials(): ICredentials; |
|
43 | 43 | } |
@@ -29,31 +29,31 @@ |
||
29 | 29 | * @since 12 |
30 | 30 | */ |
31 | 31 | interface ICredentials { |
32 | - /** |
|
33 | - * Get the user UID |
|
34 | - * |
|
35 | - * @since 12 |
|
36 | - * |
|
37 | - * @return string |
|
38 | - */ |
|
39 | - public function getUID(); |
|
32 | + /** |
|
33 | + * Get the user UID |
|
34 | + * |
|
35 | + * @since 12 |
|
36 | + * |
|
37 | + * @return string |
|
38 | + */ |
|
39 | + public function getUID(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Get the login name the users used to login |
|
43 | - * |
|
44 | - * @since 12 |
|
45 | - * |
|
46 | - * @return string |
|
47 | - */ |
|
48 | - public function getLoginName(); |
|
41 | + /** |
|
42 | + * Get the login name the users used to login |
|
43 | + * |
|
44 | + * @since 12 |
|
45 | + * |
|
46 | + * @return string |
|
47 | + */ |
|
48 | + public function getLoginName(); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Get the password |
|
52 | - * |
|
53 | - * @since 12 |
|
54 | - * |
|
55 | - * @return string|null |
|
56 | - * @throws PasswordUnavailableException |
|
57 | - */ |
|
58 | - public function getPassword(); |
|
50 | + /** |
|
51 | + * Get the password |
|
52 | + * |
|
53 | + * @since 12 |
|
54 | + * |
|
55 | + * @return string|null |
|
56 | + * @throws PasswordUnavailableException |
|
57 | + */ |
|
58 | + public function getPassword(); |
|
59 | 59 | } |
@@ -35,22 +35,22 @@ |
||
35 | 35 | */ |
36 | 36 | |
37 | 37 | interface IAvatarManager { |
38 | - /** |
|
39 | - * Return a user specific instance of \OCP\IAvatar |
|
40 | - * @see IAvatar |
|
41 | - * @param string $userId the Nextcloud user id |
|
42 | - * @throws \Exception In case the username is potentially dangerous |
|
43 | - * @throws \OCP\Files\NotFoundException In case there is no user folder yet |
|
44 | - * @since 6.0.0 |
|
45 | - */ |
|
46 | - public function getAvatar(string $userId): IAvatar; |
|
38 | + /** |
|
39 | + * Return a user specific instance of \OCP\IAvatar |
|
40 | + * @see IAvatar |
|
41 | + * @param string $userId the Nextcloud user id |
|
42 | + * @throws \Exception In case the username is potentially dangerous |
|
43 | + * @throws \OCP\Files\NotFoundException In case there is no user folder yet |
|
44 | + * @since 6.0.0 |
|
45 | + */ |
|
46 | + public function getAvatar(string $userId): IAvatar; |
|
47 | 47 | |
48 | - /** |
|
49 | - * Returns a guest user avatar instance. |
|
50 | - * |
|
51 | - * @param string $name The guest name, e.g. "Albert". |
|
52 | - * @return IAvatar |
|
53 | - * @since 16.0.0 |
|
54 | - */ |
|
55 | - public function getGuestAvatar(string $name): IAvatar; |
|
48 | + /** |
|
49 | + * Returns a guest user avatar instance. |
|
50 | + * |
|
51 | + * @param string $name The guest name, e.g. "Albert". |
|
52 | + * @return IAvatar |
|
53 | + * @since 16.0.0 |
|
54 | + */ |
|
55 | + public function getGuestAvatar(string $name): IAvatar; |
|
56 | 56 | } |
@@ -35,28 +35,28 @@ |
||
35 | 35 | * @since 9.0.0 |
36 | 36 | */ |
37 | 37 | interface ISystemTagManagerFactory { |
38 | - /** |
|
39 | - * Constructor for the system tag manager factory |
|
40 | - * |
|
41 | - * @param IServerContainer $serverContainer server container |
|
42 | - * @since 9.0.0 |
|
43 | - */ |
|
44 | - public function __construct(IServerContainer $serverContainer); |
|
38 | + /** |
|
39 | + * Constructor for the system tag manager factory |
|
40 | + * |
|
41 | + * @param IServerContainer $serverContainer server container |
|
42 | + * @since 9.0.0 |
|
43 | + */ |
|
44 | + public function __construct(IServerContainer $serverContainer); |
|
45 | 45 | |
46 | - /** |
|
47 | - * creates and returns an instance of the system tag manager |
|
48 | - * |
|
49 | - * @return ISystemTagManager |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function getManager(): ISystemTagManager; |
|
46 | + /** |
|
47 | + * creates and returns an instance of the system tag manager |
|
48 | + * |
|
49 | + * @return ISystemTagManager |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function getManager(): ISystemTagManager; |
|
53 | 53 | |
54 | - /** |
|
55 | - * creates and returns an instance of the system tag object |
|
56 | - * mapper |
|
57 | - * |
|
58 | - * @return ISystemTagObjectMapper |
|
59 | - * @since 9.0.0 |
|
60 | - */ |
|
61 | - public function getObjectMapper(): ISystemTagObjectMapper; |
|
54 | + /** |
|
55 | + * creates and returns an instance of the system tag object |
|
56 | + * mapper |
|
57 | + * |
|
58 | + * @return ISystemTagObjectMapper |
|
59 | + * @since 9.0.0 |
|
60 | + */ |
|
61 | + public function getObjectMapper(): ISystemTagObjectMapper; |
|
62 | 62 | } |
@@ -31,11 +31,11 @@ |
||
31 | 31 | * @template T of Event |
32 | 32 | */ |
33 | 33 | interface IEventListener { |
34 | - /** |
|
35 | - * @param Event $event |
|
36 | - * @psalm-param T $event |
|
37 | - * |
|
38 | - * @since 17.0.0 |
|
39 | - */ |
|
40 | - public function handle(Event $event): void; |
|
34 | + /** |
|
35 | + * @param Event $event |
|
36 | + * @psalm-param T $event |
|
37 | + * |
|
38 | + * @since 17.0.0 |
|
39 | + */ |
|
40 | + public function handle(Event $event): void; |
|
41 | 41 | } |
@@ -41,45 +41,45 @@ |
||
41 | 41 | * @since 17.0.0 |
42 | 42 | */ |
43 | 43 | class Event implements StoppableEventInterface { |
44 | - /** |
|
45 | - * @var bool |
|
46 | - * |
|
47 | - * @since 22.0.0 |
|
48 | - */ |
|
49 | - private $propagationStopped = false; |
|
44 | + /** |
|
45 | + * @var bool |
|
46 | + * |
|
47 | + * @since 22.0.0 |
|
48 | + */ |
|
49 | + private $propagationStopped = false; |
|
50 | 50 | |
51 | - /** |
|
52 | - * Compatibility constructor |
|
53 | - * |
|
54 | - * In Nextcloud 17.0.0 this event class used a now deprecated/removed Symfony base |
|
55 | - * class that had a constructor (with default arguments). To lower the risk of |
|
56 | - * a breaking change (PHP won't allow parent constructor calls if there is none), |
|
57 | - * this empty constructor's only purpose is to hopefully not break existing sub- |
|
58 | - * classes of this class. |
|
59 | - * |
|
60 | - * @since 18.0.0 |
|
61 | - */ |
|
62 | - public function __construct() { |
|
63 | - } |
|
51 | + /** |
|
52 | + * Compatibility constructor |
|
53 | + * |
|
54 | + * In Nextcloud 17.0.0 this event class used a now deprecated/removed Symfony base |
|
55 | + * class that had a constructor (with default arguments). To lower the risk of |
|
56 | + * a breaking change (PHP won't allow parent constructor calls if there is none), |
|
57 | + * this empty constructor's only purpose is to hopefully not break existing sub- |
|
58 | + * classes of this class. |
|
59 | + * |
|
60 | + * @since 18.0.0 |
|
61 | + */ |
|
62 | + public function __construct() { |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * Stops the propagation of the event to further event listeners |
|
67 | - * |
|
68 | - * @return void |
|
69 | - * |
|
70 | - * @since 22.0.0 |
|
71 | - */ |
|
72 | - public function stopPropagation(): void { |
|
73 | - $this->propagationStopped = true; |
|
74 | - } |
|
65 | + /** |
|
66 | + * Stops the propagation of the event to further event listeners |
|
67 | + * |
|
68 | + * @return void |
|
69 | + * |
|
70 | + * @since 22.0.0 |
|
71 | + */ |
|
72 | + public function stopPropagation(): void { |
|
73 | + $this->propagationStopped = true; |
|
74 | + } |
|
75 | 75 | |
76 | - /** |
|
77 | - * {@inheritDoc} |
|
78 | - * |
|
79 | - * @since 22.0.0 |
|
80 | - * @see \Psr\EventDispatcher\StoppableEventInterface |
|
81 | - */ |
|
82 | - public function isPropagationStopped(): bool { |
|
83 | - return $this->propagationStopped; |
|
84 | - } |
|
76 | + /** |
|
77 | + * {@inheritDoc} |
|
78 | + * |
|
79 | + * @since 22.0.0 |
|
80 | + * @see \Psr\EventDispatcher\StoppableEventInterface |
|
81 | + */ |
|
82 | + public function isPropagationStopped(): bool { |
|
83 | + return $this->propagationStopped; |
|
84 | + } |
|
85 | 85 | } |
@@ -31,10 +31,10 @@ |
||
31 | 31 | * @since 8.0.0 |
32 | 32 | */ |
33 | 33 | interface IUserBackend { |
34 | - /** |
|
35 | - * Backend name to be shown in user management |
|
36 | - * @return string the name of the backend to be shown |
|
37 | - * @since 8.0.0 |
|
38 | - */ |
|
39 | - public function getBackendName(); |
|
34 | + /** |
|
35 | + * Backend name to be shown in user management |
|
36 | + * @return string the name of the backend to be shown |
|
37 | + * @since 8.0.0 |
|
38 | + */ |
|
39 | + public function getBackendName(); |
|
40 | 40 | } |
@@ -30,10 +30,10 @@ |
||
30 | 30 | * @since 23.0.0 |
31 | 31 | */ |
32 | 32 | class ParameterDoesNotExistException extends \Exception { |
33 | - /** |
|
34 | - * @since 23.0.0 |
|
35 | - */ |
|
36 | - public function __construct($parameter) { |
|
37 | - parent::__construct("Parameter $parameter does not exist."); |
|
38 | - } |
|
33 | + /** |
|
34 | + * @since 23.0.0 |
|
35 | + */ |
|
36 | + public function __construct($parameter) { |
|
37 | + parent::__construct("Parameter $parameter does not exist."); |
|
38 | + } |
|
39 | 39 | } |
@@ -32,83 +32,83 @@ |
||
32 | 32 | * @since 23.0.0 |
33 | 33 | */ |
34 | 34 | interface ILinkAction { |
35 | - /** |
|
36 | - * Preload the user specific value required by the action |
|
37 | - * |
|
38 | - * e.g. the email is loaded for the email action and the userId for the Talk action |
|
39 | - * |
|
40 | - * @since 23.0.0 |
|
41 | - */ |
|
42 | - public function preload(IUser $targetUser): void; |
|
35 | + /** |
|
36 | + * Preload the user specific value required by the action |
|
37 | + * |
|
38 | + * e.g. the email is loaded for the email action and the userId for the Talk action |
|
39 | + * |
|
40 | + * @since 23.0.0 |
|
41 | + */ |
|
42 | + public function preload(IUser $targetUser): void; |
|
43 | 43 | |
44 | - /** |
|
45 | - * Returns the app ID of the action |
|
46 | - * |
|
47 | - * e.g. 'spreed' |
|
48 | - * |
|
49 | - * @since 23.0.0 |
|
50 | - */ |
|
51 | - public function getAppId(): string; |
|
44 | + /** |
|
45 | + * Returns the app ID of the action |
|
46 | + * |
|
47 | + * e.g. 'spreed' |
|
48 | + * |
|
49 | + * @since 23.0.0 |
|
50 | + */ |
|
51 | + public function getAppId(): string; |
|
52 | 52 | |
53 | - /** |
|
54 | - * Returns the unique ID of the action |
|
55 | - * |
|
56 | - * *For account properties this is the constant defined in lib/public/Accounts/IAccountManager.php* |
|
57 | - * |
|
58 | - * e.g. 'email' |
|
59 | - * |
|
60 | - * @since 23.0.0 |
|
61 | - */ |
|
62 | - public function getId(): string; |
|
53 | + /** |
|
54 | + * Returns the unique ID of the action |
|
55 | + * |
|
56 | + * *For account properties this is the constant defined in lib/public/Accounts/IAccountManager.php* |
|
57 | + * |
|
58 | + * e.g. 'email' |
|
59 | + * |
|
60 | + * @since 23.0.0 |
|
61 | + */ |
|
62 | + public function getId(): string; |
|
63 | 63 | |
64 | - /** |
|
65 | - * Returns the translated unique display ID of the action |
|
66 | - * |
|
67 | - * Should be something short and descriptive of the action |
|
68 | - * as this is seen by the end-user when configuring actions |
|
69 | - * |
|
70 | - * e.g. 'Email' |
|
71 | - * |
|
72 | - * @since 23.0.0 |
|
73 | - */ |
|
74 | - public function getDisplayId(): string; |
|
64 | + /** |
|
65 | + * Returns the translated unique display ID of the action |
|
66 | + * |
|
67 | + * Should be something short and descriptive of the action |
|
68 | + * as this is seen by the end-user when configuring actions |
|
69 | + * |
|
70 | + * e.g. 'Email' |
|
71 | + * |
|
72 | + * @since 23.0.0 |
|
73 | + */ |
|
74 | + public function getDisplayId(): string; |
|
75 | 75 | |
76 | - /** |
|
77 | - * Returns the translated title |
|
78 | - * |
|
79 | - * e.g. 'Mail [email protected]' |
|
80 | - * |
|
81 | - * Use the L10N service to translate it |
|
82 | - * |
|
83 | - * @since 23.0.0 |
|
84 | - */ |
|
85 | - public function getTitle(): string; |
|
76 | + /** |
|
77 | + * Returns the translated title |
|
78 | + * |
|
79 | + * e.g. 'Mail [email protected]' |
|
80 | + * |
|
81 | + * Use the L10N service to translate it |
|
82 | + * |
|
83 | + * @since 23.0.0 |
|
84 | + */ |
|
85 | + public function getTitle(): string; |
|
86 | 86 | |
87 | - /** |
|
88 | - * Returns the priority |
|
89 | - * |
|
90 | - * *Actions are sorted in ascending order* |
|
91 | - * |
|
92 | - * e.g. 60 |
|
93 | - * |
|
94 | - * @since 23.0.0 |
|
95 | - */ |
|
96 | - public function getPriority(): int; |
|
87 | + /** |
|
88 | + * Returns the priority |
|
89 | + * |
|
90 | + * *Actions are sorted in ascending order* |
|
91 | + * |
|
92 | + * e.g. 60 |
|
93 | + * |
|
94 | + * @since 23.0.0 |
|
95 | + */ |
|
96 | + public function getPriority(): int; |
|
97 | 97 | |
98 | - /** |
|
99 | - * Returns the URL link to the 16*16 SVG icon |
|
100 | - * |
|
101 | - * @since 23.0.0 |
|
102 | - */ |
|
103 | - public function getIcon(): string; |
|
98 | + /** |
|
99 | + * Returns the URL link to the 16*16 SVG icon |
|
100 | + * |
|
101 | + * @since 23.0.0 |
|
102 | + */ |
|
103 | + public function getIcon(): string; |
|
104 | 104 | |
105 | - /** |
|
106 | - * Returns the target of the action, |
|
107 | - * if null is returned the action won't be registered |
|
108 | - * |
|
109 | - * e.g. 'mailto:[email protected]' |
|
110 | - * |
|
111 | - * @since 23.0.0 |
|
112 | - */ |
|
113 | - public function getTarget(): ?string; |
|
105 | + /** |
|
106 | + * Returns the target of the action, |
|
107 | + * if null is returned the action won't be registered |
|
108 | + * |
|
109 | + * e.g. 'mailto:[email protected]' |
|
110 | + * |
|
111 | + * @since 23.0.0 |
|
112 | + */ |
|
113 | + public function getTarget(): ?string; |
|
114 | 114 | } |