@@ -32,22 +32,22 @@ |
||
32 | 32 | * @since 18.0.0 |
33 | 33 | */ |
34 | 34 | class ShareCreatedEvent extends Event { |
35 | - /** @var IShare */ |
|
36 | - private $share; |
|
35 | + /** @var IShare */ |
|
36 | + private $share; |
|
37 | 37 | |
38 | - /** |
|
39 | - * @since 18.0.0 |
|
40 | - */ |
|
41 | - public function __construct(IShare $share) { |
|
42 | - parent::__construct(); |
|
38 | + /** |
|
39 | + * @since 18.0.0 |
|
40 | + */ |
|
41 | + public function __construct(IShare $share) { |
|
42 | + parent::__construct(); |
|
43 | 43 | |
44 | - $this->share = $share; |
|
45 | - } |
|
44 | + $this->share = $share; |
|
45 | + } |
|
46 | 46 | |
47 | - /** |
|
48 | - * @since 18.0.0 |
|
49 | - */ |
|
50 | - public function getShare(): IShare { |
|
51 | - return $this->share; |
|
52 | - } |
|
47 | + /** |
|
48 | + * @since 18.0.0 |
|
49 | + */ |
|
50 | + public function getShare(): IShare { |
|
51 | + return $this->share; |
|
52 | + } |
|
53 | 53 | } |
@@ -33,27 +33,27 @@ |
||
33 | 33 | * @since 21.0.0 |
34 | 34 | */ |
35 | 35 | class ShareDeletedEvent extends Event { |
36 | - /** @var IShare */ |
|
37 | - private $share; |
|
36 | + /** @var IShare */ |
|
37 | + private $share; |
|
38 | 38 | |
39 | - /** |
|
40 | - * |
|
41 | - * @param IShare $share |
|
42 | - * @param IShare[] $children |
|
43 | - * |
|
44 | - * @since 21.0.0 |
|
45 | - */ |
|
46 | - public function __construct(IShare $share) { |
|
47 | - parent::__construct(); |
|
39 | + /** |
|
40 | + * |
|
41 | + * @param IShare $share |
|
42 | + * @param IShare[] $children |
|
43 | + * |
|
44 | + * @since 21.0.0 |
|
45 | + */ |
|
46 | + public function __construct(IShare $share) { |
|
47 | + parent::__construct(); |
|
48 | 48 | |
49 | - $this->share = $share; |
|
50 | - } |
|
49 | + $this->share = $share; |
|
50 | + } |
|
51 | 51 | |
52 | - /** |
|
53 | - * @return IShare |
|
54 | - * @since 21.0.0 |
|
55 | - */ |
|
56 | - public function getShare(): IShare { |
|
57 | - return $this->share; |
|
58 | - } |
|
52 | + /** |
|
53 | + * @return IShare |
|
54 | + * @since 21.0.0 |
|
55 | + */ |
|
56 | + public function getShare(): IShare { |
|
57 | + return $this->share; |
|
58 | + } |
|
59 | 59 | } |
@@ -31,10 +31,10 @@ |
||
31 | 31 | * @since 12 |
32 | 32 | */ |
33 | 33 | interface IShareHelper { |
34 | - /** |
|
35 | - * @param Node $node |
|
36 | - * @return array [ users => [Mapping $uid => $pathForUser], remotes => [Mapping $cloudId => $pathToMountRoot]] |
|
37 | - * @since 12 |
|
38 | - */ |
|
39 | - public function getPathsForAccessList(Node $node); |
|
34 | + /** |
|
35 | + * @param Node $node |
|
36 | + * @return array [ users => [Mapping $uid => $pathForUser], remotes => [Mapping $cloudId => $pathToMountRoot]] |
|
37 | + * @since 12 |
|
38 | + */ |
|
39 | + public function getPathsForAccessList(Node $node); |
|
40 | 40 | } |
@@ -29,220 +29,220 @@ |
||
29 | 29 | * @since 14.0.0 |
30 | 30 | */ |
31 | 31 | interface ICloudFederationShare { |
32 | - /** |
|
33 | - * set uid of the recipient |
|
34 | - * |
|
35 | - * @param string $user |
|
36 | - * |
|
37 | - * @since 14.0.0 |
|
38 | - */ |
|
39 | - public function setShareWith($user); |
|
40 | - |
|
41 | - /** |
|
42 | - * set resource name (e.g. file, calendar, contact,...) |
|
43 | - * |
|
44 | - * @param string $name |
|
45 | - * |
|
46 | - * @since 14.0.0 |
|
47 | - */ |
|
48 | - public function setResourceName($name); |
|
49 | - |
|
50 | - /** |
|
51 | - * set resource type (e.g. file, calendar, contact,...) |
|
52 | - * |
|
53 | - * @param string $resourceType |
|
54 | - * |
|
55 | - * @since 14.0.0 |
|
56 | - */ |
|
57 | - public function setResourceType($resourceType); |
|
58 | - |
|
59 | - /** |
|
60 | - * set resource description (optional) |
|
61 | - * |
|
62 | - * @param string $description |
|
63 | - * |
|
64 | - * @since 14.0.0 |
|
65 | - */ |
|
66 | - public function setDescription($description); |
|
67 | - |
|
68 | - /** |
|
69 | - * set provider ID (e.g. file ID) |
|
70 | - * |
|
71 | - * @param string $providerId |
|
72 | - * |
|
73 | - * @since 14.0.0 |
|
74 | - */ |
|
75 | - public function setProviderId($providerId); |
|
76 | - |
|
77 | - /** |
|
78 | - * set owner UID |
|
79 | - * |
|
80 | - * @param string $owner |
|
81 | - * |
|
82 | - * @since 14.0.0 |
|
83 | - */ |
|
84 | - public function setOwner($owner); |
|
85 | - |
|
86 | - /** |
|
87 | - * set owner display name |
|
88 | - * |
|
89 | - * @param string $ownerDisplayName |
|
90 | - * |
|
91 | - * @since 14.0.0 |
|
92 | - */ |
|
93 | - public function setOwnerDisplayName($ownerDisplayName); |
|
94 | - |
|
95 | - /** |
|
96 | - * set UID of the user who sends the share |
|
97 | - * |
|
98 | - * @param string $sharedBy |
|
99 | - * |
|
100 | - * @since 14.0.0 |
|
101 | - */ |
|
102 | - public function setSharedBy($sharedBy); |
|
103 | - |
|
104 | - /** |
|
105 | - * set display name of the user who sends the share |
|
106 | - * |
|
107 | - * @param $sharedByDisplayName |
|
108 | - * |
|
109 | - * @since 14.0.0 |
|
110 | - */ |
|
111 | - public function setSharedByDisplayName($sharedByDisplayName); |
|
112 | - |
|
113 | - /** |
|
114 | - * set protocol specification |
|
115 | - * |
|
116 | - * @param array $protocol |
|
117 | - * |
|
118 | - * @since 14.0.0 |
|
119 | - */ |
|
120 | - public function setProtocol(array $protocol); |
|
121 | - |
|
122 | - /** |
|
123 | - * share type (group or user) |
|
124 | - * |
|
125 | - * @param string $shareType |
|
126 | - * |
|
127 | - * @since 14.0.0 |
|
128 | - */ |
|
129 | - public function setShareType($shareType); |
|
130 | - |
|
131 | - /** |
|
132 | - * get the whole share, ready to send out |
|
133 | - * |
|
134 | - * @return array |
|
135 | - * |
|
136 | - * @since 14.0.0 |
|
137 | - */ |
|
138 | - public function getShare(); |
|
139 | - |
|
140 | - /** |
|
141 | - * get uid of the recipient |
|
142 | - * |
|
143 | - * @return string |
|
144 | - * |
|
145 | - * @since 14.0.0 |
|
146 | - */ |
|
147 | - public function getShareWith(); |
|
148 | - |
|
149 | - /** |
|
150 | - * get resource name (e.g. file, calendar, contact,...) |
|
151 | - * |
|
152 | - * @return string |
|
153 | - * |
|
154 | - * @since 14.0.0 |
|
155 | - */ |
|
156 | - public function getResourceName(); |
|
157 | - |
|
158 | - /** |
|
159 | - * get resource type (e.g. file, calendar, contact,...) |
|
160 | - * |
|
161 | - * @return string |
|
162 | - * |
|
163 | - * @since 14.0.0 |
|
164 | - */ |
|
165 | - public function getResourceType(); |
|
166 | - |
|
167 | - /** |
|
168 | - * get resource description (optional) |
|
169 | - * |
|
170 | - * @return string |
|
171 | - * |
|
172 | - * @since 14.0.0 |
|
173 | - */ |
|
174 | - public function getDescription(); |
|
175 | - |
|
176 | - /** |
|
177 | - * get provider ID (e.g. file ID) |
|
178 | - * |
|
179 | - * @return string |
|
180 | - * |
|
181 | - * @since 14.0.0 |
|
182 | - */ |
|
183 | - public function getProviderId(); |
|
184 | - |
|
185 | - /** |
|
186 | - * get owner UID |
|
187 | - * |
|
188 | - * @return string |
|
189 | - * |
|
190 | - * @since 14.0.0 |
|
191 | - */ |
|
192 | - public function getOwner(); |
|
193 | - |
|
194 | - /** |
|
195 | - * get owner display name |
|
196 | - * |
|
197 | - * @return string |
|
198 | - * |
|
199 | - * @since 14.0.0 |
|
200 | - */ |
|
201 | - public function getOwnerDisplayName(); |
|
202 | - |
|
203 | - /** |
|
204 | - * get UID of the user who sends the share |
|
205 | - * |
|
206 | - * @return string |
|
207 | - * |
|
208 | - * @since 14.0.0 |
|
209 | - */ |
|
210 | - public function getSharedBy(); |
|
211 | - |
|
212 | - /** |
|
213 | - * get display name of the user who sends the share |
|
214 | - * |
|
215 | - * @return string |
|
216 | - * |
|
217 | - * @since 14.0.0 |
|
218 | - */ |
|
219 | - public function getSharedByDisplayName(); |
|
220 | - |
|
221 | - /** |
|
222 | - * get share type (group or user) |
|
223 | - * |
|
224 | - * @return string |
|
225 | - * |
|
226 | - * @since 14.0.0 |
|
227 | - */ |
|
228 | - public function getShareType(); |
|
229 | - |
|
230 | - /** |
|
231 | - * get share Secret |
|
232 | - * |
|
233 | - * @return string |
|
234 | - * |
|
235 | - * @since 14.0.0 |
|
236 | - */ |
|
237 | - public function getShareSecret(); |
|
238 | - |
|
239 | - |
|
240 | - /** |
|
241 | - * get protocol specification |
|
242 | - * |
|
243 | - * @return array |
|
244 | - * |
|
245 | - * @since 14.0.0 |
|
246 | - */ |
|
247 | - public function getProtocol(); |
|
32 | + /** |
|
33 | + * set uid of the recipient |
|
34 | + * |
|
35 | + * @param string $user |
|
36 | + * |
|
37 | + * @since 14.0.0 |
|
38 | + */ |
|
39 | + public function setShareWith($user); |
|
40 | + |
|
41 | + /** |
|
42 | + * set resource name (e.g. file, calendar, contact,...) |
|
43 | + * |
|
44 | + * @param string $name |
|
45 | + * |
|
46 | + * @since 14.0.0 |
|
47 | + */ |
|
48 | + public function setResourceName($name); |
|
49 | + |
|
50 | + /** |
|
51 | + * set resource type (e.g. file, calendar, contact,...) |
|
52 | + * |
|
53 | + * @param string $resourceType |
|
54 | + * |
|
55 | + * @since 14.0.0 |
|
56 | + */ |
|
57 | + public function setResourceType($resourceType); |
|
58 | + |
|
59 | + /** |
|
60 | + * set resource description (optional) |
|
61 | + * |
|
62 | + * @param string $description |
|
63 | + * |
|
64 | + * @since 14.0.0 |
|
65 | + */ |
|
66 | + public function setDescription($description); |
|
67 | + |
|
68 | + /** |
|
69 | + * set provider ID (e.g. file ID) |
|
70 | + * |
|
71 | + * @param string $providerId |
|
72 | + * |
|
73 | + * @since 14.0.0 |
|
74 | + */ |
|
75 | + public function setProviderId($providerId); |
|
76 | + |
|
77 | + /** |
|
78 | + * set owner UID |
|
79 | + * |
|
80 | + * @param string $owner |
|
81 | + * |
|
82 | + * @since 14.0.0 |
|
83 | + */ |
|
84 | + public function setOwner($owner); |
|
85 | + |
|
86 | + /** |
|
87 | + * set owner display name |
|
88 | + * |
|
89 | + * @param string $ownerDisplayName |
|
90 | + * |
|
91 | + * @since 14.0.0 |
|
92 | + */ |
|
93 | + public function setOwnerDisplayName($ownerDisplayName); |
|
94 | + |
|
95 | + /** |
|
96 | + * set UID of the user who sends the share |
|
97 | + * |
|
98 | + * @param string $sharedBy |
|
99 | + * |
|
100 | + * @since 14.0.0 |
|
101 | + */ |
|
102 | + public function setSharedBy($sharedBy); |
|
103 | + |
|
104 | + /** |
|
105 | + * set display name of the user who sends the share |
|
106 | + * |
|
107 | + * @param $sharedByDisplayName |
|
108 | + * |
|
109 | + * @since 14.0.0 |
|
110 | + */ |
|
111 | + public function setSharedByDisplayName($sharedByDisplayName); |
|
112 | + |
|
113 | + /** |
|
114 | + * set protocol specification |
|
115 | + * |
|
116 | + * @param array $protocol |
|
117 | + * |
|
118 | + * @since 14.0.0 |
|
119 | + */ |
|
120 | + public function setProtocol(array $protocol); |
|
121 | + |
|
122 | + /** |
|
123 | + * share type (group or user) |
|
124 | + * |
|
125 | + * @param string $shareType |
|
126 | + * |
|
127 | + * @since 14.0.0 |
|
128 | + */ |
|
129 | + public function setShareType($shareType); |
|
130 | + |
|
131 | + /** |
|
132 | + * get the whole share, ready to send out |
|
133 | + * |
|
134 | + * @return array |
|
135 | + * |
|
136 | + * @since 14.0.0 |
|
137 | + */ |
|
138 | + public function getShare(); |
|
139 | + |
|
140 | + /** |
|
141 | + * get uid of the recipient |
|
142 | + * |
|
143 | + * @return string |
|
144 | + * |
|
145 | + * @since 14.0.0 |
|
146 | + */ |
|
147 | + public function getShareWith(); |
|
148 | + |
|
149 | + /** |
|
150 | + * get resource name (e.g. file, calendar, contact,...) |
|
151 | + * |
|
152 | + * @return string |
|
153 | + * |
|
154 | + * @since 14.0.0 |
|
155 | + */ |
|
156 | + public function getResourceName(); |
|
157 | + |
|
158 | + /** |
|
159 | + * get resource type (e.g. file, calendar, contact,...) |
|
160 | + * |
|
161 | + * @return string |
|
162 | + * |
|
163 | + * @since 14.0.0 |
|
164 | + */ |
|
165 | + public function getResourceType(); |
|
166 | + |
|
167 | + /** |
|
168 | + * get resource description (optional) |
|
169 | + * |
|
170 | + * @return string |
|
171 | + * |
|
172 | + * @since 14.0.0 |
|
173 | + */ |
|
174 | + public function getDescription(); |
|
175 | + |
|
176 | + /** |
|
177 | + * get provider ID (e.g. file ID) |
|
178 | + * |
|
179 | + * @return string |
|
180 | + * |
|
181 | + * @since 14.0.0 |
|
182 | + */ |
|
183 | + public function getProviderId(); |
|
184 | + |
|
185 | + /** |
|
186 | + * get owner UID |
|
187 | + * |
|
188 | + * @return string |
|
189 | + * |
|
190 | + * @since 14.0.0 |
|
191 | + */ |
|
192 | + public function getOwner(); |
|
193 | + |
|
194 | + /** |
|
195 | + * get owner display name |
|
196 | + * |
|
197 | + * @return string |
|
198 | + * |
|
199 | + * @since 14.0.0 |
|
200 | + */ |
|
201 | + public function getOwnerDisplayName(); |
|
202 | + |
|
203 | + /** |
|
204 | + * get UID of the user who sends the share |
|
205 | + * |
|
206 | + * @return string |
|
207 | + * |
|
208 | + * @since 14.0.0 |
|
209 | + */ |
|
210 | + public function getSharedBy(); |
|
211 | + |
|
212 | + /** |
|
213 | + * get display name of the user who sends the share |
|
214 | + * |
|
215 | + * @return string |
|
216 | + * |
|
217 | + * @since 14.0.0 |
|
218 | + */ |
|
219 | + public function getSharedByDisplayName(); |
|
220 | + |
|
221 | + /** |
|
222 | + * get share type (group or user) |
|
223 | + * |
|
224 | + * @return string |
|
225 | + * |
|
226 | + * @since 14.0.0 |
|
227 | + */ |
|
228 | + public function getShareType(); |
|
229 | + |
|
230 | + /** |
|
231 | + * get share Secret |
|
232 | + * |
|
233 | + * @return string |
|
234 | + * |
|
235 | + * @since 14.0.0 |
|
236 | + */ |
|
237 | + public function getShareSecret(); |
|
238 | + |
|
239 | + |
|
240 | + /** |
|
241 | + * get protocol specification |
|
242 | + * |
|
243 | + * @return array |
|
244 | + * |
|
245 | + * @since 14.0.0 |
|
246 | + */ |
|
247 | + public function getProtocol(); |
|
248 | 248 | } |
@@ -29,33 +29,33 @@ |
||
29 | 29 | * @since 14.0.0 |
30 | 30 | */ |
31 | 31 | interface ICloudFederationFactory { |
32 | - /** |
|
33 | - * get a CloudFederationShare Object to prepare a share you want to send |
|
34 | - * |
|
35 | - * @param string $shareWith |
|
36 | - * @param string $name resource name (e.g. document.odt) |
|
37 | - * @param string $description share description (optional) |
|
38 | - * @param string $providerId resource UID on the provider side |
|
39 | - * @param string $owner provider specific UID of the user who owns the resource |
|
40 | - * @param string $ownerDisplayName display name of the user who shared the item |
|
41 | - * @param string $sharedBy provider specific UID of the user who shared the resource |
|
42 | - * @param string $sharedByDisplayName display name of the user who shared the resource |
|
43 | - * @param string $sharedSecret used to authenticate requests across servers |
|
44 | - * @param string $shareType ('group' or 'user' share) |
|
45 | - * @param $resourceType ('file', 'calendar',...) |
|
46 | - * @return ICloudFederationShare |
|
47 | - * |
|
48 | - * @since 14.0.0 |
|
49 | - */ |
|
50 | - public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType); |
|
32 | + /** |
|
33 | + * get a CloudFederationShare Object to prepare a share you want to send |
|
34 | + * |
|
35 | + * @param string $shareWith |
|
36 | + * @param string $name resource name (e.g. document.odt) |
|
37 | + * @param string $description share description (optional) |
|
38 | + * @param string $providerId resource UID on the provider side |
|
39 | + * @param string $owner provider specific UID of the user who owns the resource |
|
40 | + * @param string $ownerDisplayName display name of the user who shared the item |
|
41 | + * @param string $sharedBy provider specific UID of the user who shared the resource |
|
42 | + * @param string $sharedByDisplayName display name of the user who shared the resource |
|
43 | + * @param string $sharedSecret used to authenticate requests across servers |
|
44 | + * @param string $shareType ('group' or 'user' share) |
|
45 | + * @param $resourceType ('file', 'calendar',...) |
|
46 | + * @return ICloudFederationShare |
|
47 | + * |
|
48 | + * @since 14.0.0 |
|
49 | + */ |
|
50 | + public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType); |
|
51 | 51 | |
52 | - /** |
|
53 | - * get a Cloud FederationNotification object to prepare a notification you |
|
54 | - * want to send |
|
55 | - * |
|
56 | - * @return ICloudFederationNotification |
|
57 | - * |
|
58 | - * @since 14.0.0 |
|
59 | - */ |
|
60 | - public function getCloudFederationNotification(); |
|
52 | + /** |
|
53 | + * get a Cloud FederationNotification object to prepare a notification you |
|
54 | + * want to send |
|
55 | + * |
|
56 | + * @return ICloudFederationNotification |
|
57 | + * |
|
58 | + * @since 14.0.0 |
|
59 | + */ |
|
60 | + public function getCloudFederationNotification(); |
|
61 | 61 | } |
@@ -34,73 +34,73 @@ |
||
34 | 34 | * @since 6.0.0 |
35 | 35 | */ |
36 | 36 | interface IAvatar { |
37 | - /** |
|
38 | - * Get the users avatar |
|
39 | - * |
|
40 | - * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image |
|
41 | - * @param bool $darkTheme Should the generated avatar be dark themed |
|
42 | - * @return false|\OCP\IImage containing the avatar or false if there's no image |
|
43 | - * @since 6.0.0 - size of -1 was added in 9.0.0 |
|
44 | - */ |
|
45 | - public function get(int $size = 64, bool $darkTheme = false); |
|
37 | + /** |
|
38 | + * Get the users avatar |
|
39 | + * |
|
40 | + * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image |
|
41 | + * @param bool $darkTheme Should the generated avatar be dark themed |
|
42 | + * @return false|\OCP\IImage containing the avatar or false if there's no image |
|
43 | + * @since 6.0.0 - size of -1 was added in 9.0.0 |
|
44 | + */ |
|
45 | + public function get(int $size = 64, bool $darkTheme = false); |
|
46 | 46 | |
47 | - /** |
|
48 | - * Check if an avatar exists for the user |
|
49 | - * |
|
50 | - * @since 8.1.0 |
|
51 | - */ |
|
52 | - public function exists(): bool; |
|
47 | + /** |
|
48 | + * Check if an avatar exists for the user |
|
49 | + * |
|
50 | + * @since 8.1.0 |
|
51 | + */ |
|
52 | + public function exists(): bool; |
|
53 | 53 | |
54 | - /** |
|
55 | - * Check if the avatar of a user is a custom uploaded one |
|
56 | - * |
|
57 | - * @since 14.0.0 |
|
58 | - */ |
|
59 | - public function isCustomAvatar(): bool; |
|
54 | + /** |
|
55 | + * Check if the avatar of a user is a custom uploaded one |
|
56 | + * |
|
57 | + * @since 14.0.0 |
|
58 | + */ |
|
59 | + public function isCustomAvatar(): bool; |
|
60 | 60 | |
61 | - /** |
|
62 | - * Sets the users avatar |
|
63 | - * |
|
64 | - * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar |
|
65 | - * @throws \Exception if the provided file is not a jpg or png image |
|
66 | - * @throws \Exception if the provided image is not valid |
|
67 | - * @throws \OC\NotSquareException if the image is not square |
|
68 | - * @since 6.0.0 |
|
69 | - */ |
|
70 | - public function set($data): void; |
|
61 | + /** |
|
62 | + * Sets the users avatar |
|
63 | + * |
|
64 | + * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar |
|
65 | + * @throws \Exception if the provided file is not a jpg or png image |
|
66 | + * @throws \Exception if the provided image is not valid |
|
67 | + * @throws \OC\NotSquareException if the image is not square |
|
68 | + * @since 6.0.0 |
|
69 | + */ |
|
70 | + public function set($data): void; |
|
71 | 71 | |
72 | - /** |
|
73 | - * Remove the user's avatar |
|
74 | - * |
|
75 | - * @param bool $silent Whether removing the avatar should trigger a change |
|
76 | - * @since 6.0.0 |
|
77 | - */ |
|
78 | - public function remove(bool $silent = false): void; |
|
72 | + /** |
|
73 | + * Remove the user's avatar |
|
74 | + * |
|
75 | + * @param bool $silent Whether removing the avatar should trigger a change |
|
76 | + * @since 6.0.0 |
|
77 | + */ |
|
78 | + public function remove(bool $silent = false): void; |
|
79 | 79 | |
80 | - /** |
|
81 | - * Get the file of the avatar |
|
82 | - * |
|
83 | - * @param int $size The desired image size. -1 can be used to not scale the image |
|
84 | - * @param bool $darkTheme Should the generated avatar be dark themed |
|
85 | - * @throws NotFoundException |
|
86 | - * @since 9.0.0 |
|
87 | - */ |
|
88 | - public function getFile(int $size, bool $darkTheme = false): ISimpleFile; |
|
80 | + /** |
|
81 | + * Get the file of the avatar |
|
82 | + * |
|
83 | + * @param int $size The desired image size. -1 can be used to not scale the image |
|
84 | + * @param bool $darkTheme Should the generated avatar be dark themed |
|
85 | + * @throws NotFoundException |
|
86 | + * @since 9.0.0 |
|
87 | + */ |
|
88 | + public function getFile(int $size, bool $darkTheme = false): ISimpleFile; |
|
89 | 89 | |
90 | - /** |
|
91 | - * Get the avatar background color |
|
92 | - * |
|
93 | - * @since 14.0.0 |
|
94 | - */ |
|
95 | - public function avatarBackgroundColor(string $hash): Color; |
|
90 | + /** |
|
91 | + * Get the avatar background color |
|
92 | + * |
|
93 | + * @since 14.0.0 |
|
94 | + */ |
|
95 | + public function avatarBackgroundColor(string $hash): Color; |
|
96 | 96 | |
97 | - /** |
|
98 | - * Updates the display name if changed. |
|
99 | - * |
|
100 | - * @param string $feature The changed feature |
|
101 | - * @param mixed $oldValue The previous value |
|
102 | - * @param mixed $newValue The new value |
|
103 | - * @since 13.0.0 |
|
104 | - */ |
|
105 | - public function userChanged(string $feature, $oldValue, $newValue): void; |
|
97 | + /** |
|
98 | + * Updates the display name if changed. |
|
99 | + * |
|
100 | + * @param string $feature The changed feature |
|
101 | + * @param mixed $oldValue The previous value |
|
102 | + * @param mixed $newValue The new value |
|
103 | + * @since 13.0.0 |
|
104 | + */ |
|
105 | + public function userChanged(string $feature, $oldValue, $newValue): void; |
|
106 | 106 | } |
@@ -29,14 +29,14 @@ |
||
29 | 29 | * @since 15.0.0 |
30 | 30 | */ |
31 | 31 | interface ICollectBreadcrumbs extends IReporter { |
32 | - /** |
|
33 | - * Collect breadcrumbs for crash reports |
|
34 | - * |
|
35 | - * @param string $message |
|
36 | - * @param string $category |
|
37 | - * @param array $context |
|
38 | - * |
|
39 | - * @since 15.0.0 |
|
40 | - */ |
|
41 | - public function collect(string $message, string $category, array $context = []); |
|
32 | + /** |
|
33 | + * Collect breadcrumbs for crash reports |
|
34 | + * |
|
35 | + * @param string $message |
|
36 | + * @param string $category |
|
37 | + * @param array $context |
|
38 | + * |
|
39 | + * @since 15.0.0 |
|
40 | + */ |
|
41 | + public function collect(string $message, string $category, array $context = []); |
|
42 | 42 | } |
@@ -32,12 +32,12 @@ |
||
32 | 32 | * @since 13.0.0 |
33 | 33 | */ |
34 | 34 | interface IReporter { |
35 | - /** |
|
36 | - * Report an (unhandled) exception |
|
37 | - * |
|
38 | - * @since 13.0.0 |
|
39 | - * @param Exception|Throwable $exception |
|
40 | - * @param array $context |
|
41 | - */ |
|
42 | - public function report($exception, array $context = []); |
|
35 | + /** |
|
36 | + * Report an (unhandled) exception |
|
37 | + * |
|
38 | + * @since 13.0.0 |
|
39 | + * @param Exception|Throwable $exception |
|
40 | + * @param array $context |
|
41 | + */ |
|
42 | + public function report($exception, array $context = []); |
|
43 | 43 | } |
@@ -29,13 +29,13 @@ |
||
29 | 29 | * @since 17.0.0 |
30 | 30 | */ |
31 | 31 | interface IMessageReporter extends IReporter { |
32 | - /** |
|
33 | - * Report a (error) message |
|
34 | - * |
|
35 | - * @param string $message |
|
36 | - * @param array $context |
|
37 | - * |
|
38 | - * @since 17.0.0 |
|
39 | - */ |
|
40 | - public function reportMessage(string $message, array $context = []): void; |
|
32 | + /** |
|
33 | + * Report a (error) message |
|
34 | + * |
|
35 | + * @param string $message |
|
36 | + * @param array $context |
|
37 | + * |
|
38 | + * @since 17.0.0 |
|
39 | + */ |
|
40 | + public function reportMessage(string $message, array $context = []): void; |
|
41 | 41 | } |