@@ -34,14 +34,14 @@ |
||
34 | 34 | * @since 21.0.0 |
35 | 35 | */ |
36 | 36 | interface IHandler { |
37 | - /** |
|
38 | - * @param string $service the name of the well known service, e.g. 'webfinger' |
|
39 | - * @param IRequestContext $context |
|
40 | - * @param IResponse|null $previousResponse the response of the previous handler, if any |
|
41 | - * |
|
42 | - * @return IResponse|null a response object if the request could be handled, null otherwise |
|
43 | - * |
|
44 | - * @since 21.0.0 |
|
45 | - */ |
|
46 | - public function handle(string $service, IRequestContext $context, ?IResponse $previousResponse): ?IResponse; |
|
37 | + /** |
|
38 | + * @param string $service the name of the well known service, e.g. 'webfinger' |
|
39 | + * @param IRequestContext $context |
|
40 | + * @param IResponse|null $previousResponse the response of the previous handler, if any |
|
41 | + * |
|
42 | + * @return IResponse|null a response object if the request could be handled, null otherwise |
|
43 | + * |
|
44 | + * @since 21.0.0 |
|
45 | + */ |
|
46 | + public function handle(string $service, IRequestContext $context, ?IResponse $previousResponse): ?IResponse; |
|
47 | 47 | } |
@@ -31,8 +31,8 @@ |
||
31 | 31 | * @since 21.0.0 |
32 | 32 | */ |
33 | 33 | interface IResponse { |
34 | - /** |
|
35 | - * @since 21.0.0 |
|
36 | - */ |
|
37 | - public function toHttpResponse(): Response; |
|
34 | + /** |
|
35 | + * @since 21.0.0 |
|
36 | + */ |
|
37 | + public function toHttpResponse(): Response; |
|
38 | 38 | } |
@@ -31,10 +31,10 @@ |
||
31 | 31 | * @since 18.0.1 |
32 | 32 | */ |
33 | 33 | interface IDataLogger { |
34 | - /** |
|
35 | - * allows to log custom data, similar to how logException works |
|
36 | - * |
|
37 | - * @since 18.0.1 |
|
38 | - */ |
|
39 | - public function logData(string $message, array $data, array $context = []): void; |
|
34 | + /** |
|
35 | + * allows to log custom data, similar to how logException works |
|
36 | + * |
|
37 | + * @since 18.0.1 |
|
38 | + */ |
|
39 | + public function logData(string $message, array $data, array $context = []): void; |
|
40 | 40 | } |
@@ -26,10 +26,10 @@ |
||
26 | 26 | * @since 12.0 |
27 | 27 | */ |
28 | 28 | interface IProvider { |
29 | - /** |
|
30 | - * @since 12.0 |
|
31 | - * @param IEntry $entry |
|
32 | - * @return void |
|
33 | - */ |
|
34 | - public function process(IEntry $entry); |
|
29 | + /** |
|
30 | + * @since 12.0 |
|
31 | + * @param IEntry $entry |
|
32 | + * @return void |
|
33 | + */ |
|
34 | + public function process(IEntry $entry); |
|
35 | 35 | } |
@@ -26,15 +26,15 @@ |
||
26 | 26 | * @since 12.0 |
27 | 27 | */ |
28 | 28 | interface ILinkAction extends IAction { |
29 | - /** |
|
30 | - * @param string $href the target URL of the action |
|
31 | - * @since 12.0 |
|
32 | - */ |
|
33 | - public function setHref(string $href); |
|
29 | + /** |
|
30 | + * @param string $href the target URL of the action |
|
31 | + * @since 12.0 |
|
32 | + */ |
|
33 | + public function setHref(string $href); |
|
34 | 34 | |
35 | - /** |
|
36 | - * @since 12.0 |
|
37 | - * @return string |
|
38 | - */ |
|
39 | - public function getHref(): string; |
|
35 | + /** |
|
36 | + * @since 12.0 |
|
37 | + * @return string |
|
38 | + */ |
|
39 | + public function getHref(): string; |
|
40 | 40 | } |
@@ -26,29 +26,29 @@ |
||
26 | 26 | * @since 12.0 |
27 | 27 | */ |
28 | 28 | interface IActionFactory { |
29 | - /** |
|
30 | - * Construct and return a new link action for the contacts menu |
|
31 | - * |
|
32 | - * @since 12.0 |
|
33 | - * |
|
34 | - * @param string $icon full path to the action's icon |
|
35 | - * @param string $name localized name of the action |
|
36 | - * @param string $href target URL |
|
37 | - * @param string $appId the app ID registering the action |
|
38 | - * @return ILinkAction |
|
39 | - */ |
|
40 | - public function newLinkAction(string $icon, string $name, string $href, string $appId = ''): ILinkAction; |
|
29 | + /** |
|
30 | + * Construct and return a new link action for the contacts menu |
|
31 | + * |
|
32 | + * @since 12.0 |
|
33 | + * |
|
34 | + * @param string $icon full path to the action's icon |
|
35 | + * @param string $name localized name of the action |
|
36 | + * @param string $href target URL |
|
37 | + * @param string $appId the app ID registering the action |
|
38 | + * @return ILinkAction |
|
39 | + */ |
|
40 | + public function newLinkAction(string $icon, string $name, string $href, string $appId = ''): ILinkAction; |
|
41 | 41 | |
42 | - /** |
|
43 | - * Construct and return a new email action for the contacts menu |
|
44 | - * |
|
45 | - * @since 12.0 |
|
46 | - * |
|
47 | - * @param string $icon full path to the action's icon |
|
48 | - * @param string $name localized name of the action |
|
49 | - * @param string $email target e-mail address |
|
50 | - * @param string $appId the appName registering the action |
|
51 | - * @return ILinkAction |
|
52 | - */ |
|
53 | - public function newEMailAction(string $icon, string $name, string $email, string $appId = ''): ILinkAction; |
|
42 | + /** |
|
43 | + * Construct and return a new email action for the contacts menu |
|
44 | + * |
|
45 | + * @since 12.0 |
|
46 | + * |
|
47 | + * @param string $icon full path to the action's icon |
|
48 | + * @param string $name localized name of the action |
|
49 | + * @param string $email target e-mail address |
|
50 | + * @param string $appId the appName registering the action |
|
51 | + * @return ILinkAction |
|
52 | + */ |
|
53 | + public function newEMailAction(string $icon, string $name, string $email, string $appId = ''): ILinkAction; |
|
54 | 54 | } |
@@ -30,19 +30,19 @@ |
||
30 | 30 | * @since 13.0.0 |
31 | 31 | */ |
32 | 32 | interface IContactsStore { |
33 | - /** |
|
34 | - * @param IUser $user |
|
35 | - * @param string|null $filter |
|
36 | - * @param int|null $limit added 19.0.2 |
|
37 | - * @param int|null $offset added 19.0.2 |
|
38 | - * @return IEntry[] |
|
39 | - * @since 13.0.0 |
|
40 | - */ |
|
41 | - public function getContacts(IUser $user, ?string $filter, ?int $limit = null, ?int $offset = null): array; |
|
33 | + /** |
|
34 | + * @param IUser $user |
|
35 | + * @param string|null $filter |
|
36 | + * @param int|null $limit added 19.0.2 |
|
37 | + * @param int|null $offset added 19.0.2 |
|
38 | + * @return IEntry[] |
|
39 | + * @since 13.0.0 |
|
40 | + */ |
|
41 | + public function getContacts(IUser $user, ?string $filter, ?int $limit = null, ?int $offset = null): array; |
|
42 | 42 | |
43 | - /** |
|
44 | - * @brief finds a contact by specifying the property to search on ($shareType) and the value ($shareWith) |
|
45 | - * @since 13.0.0 |
|
46 | - */ |
|
47 | - public function findOne(IUser $user, int $shareType, string $shareWith): ?IEntry; |
|
43 | + /** |
|
44 | + * @brief finds a contact by specifying the property to search on ($shareType) and the value ($shareWith) |
|
45 | + * @since 13.0.0 |
|
46 | + */ |
|
47 | + public function findOne(IUser $user, int $shareType, string $shareWith): ?IEntry; |
|
48 | 48 | } |
@@ -39,96 +39,96 @@ |
||
39 | 39 | * @since 19.0.0 |
40 | 40 | */ |
41 | 41 | class ContactInteractedWithEvent extends Event { |
42 | - /** @var IUser */ |
|
43 | - private $actor; |
|
42 | + /** @var IUser */ |
|
43 | + private $actor; |
|
44 | 44 | |
45 | - /** @var string|null */ |
|
46 | - private $uid; |
|
45 | + /** @var string|null */ |
|
46 | + private $uid; |
|
47 | 47 | |
48 | - /** @var string|null */ |
|
49 | - private $email; |
|
48 | + /** @var string|null */ |
|
49 | + private $email; |
|
50 | 50 | |
51 | - /** @var string|null */ |
|
52 | - private $federatedCloudId; |
|
51 | + /** @var string|null */ |
|
52 | + private $federatedCloudId; |
|
53 | 53 | |
54 | - /** |
|
55 | - * @param IUser $actor the user who started the interaction |
|
56 | - * |
|
57 | - * @since 19.0.0 |
|
58 | - */ |
|
59 | - public function __construct(IUser $actor) { |
|
60 | - parent::__construct(); |
|
61 | - $this->actor = $actor; |
|
62 | - } |
|
54 | + /** |
|
55 | + * @param IUser $actor the user who started the interaction |
|
56 | + * |
|
57 | + * @since 19.0.0 |
|
58 | + */ |
|
59 | + public function __construct(IUser $actor) { |
|
60 | + parent::__construct(); |
|
61 | + $this->actor = $actor; |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * @return IUser |
|
66 | - * @since 19.0.0 |
|
67 | - */ |
|
68 | - public function getActor(): IUser { |
|
69 | - return $this->actor; |
|
70 | - } |
|
64 | + /** |
|
65 | + * @return IUser |
|
66 | + * @since 19.0.0 |
|
67 | + */ |
|
68 | + public function getActor(): IUser { |
|
69 | + return $this->actor; |
|
70 | + } |
|
71 | 71 | |
72 | - /** |
|
73 | - * @return string|null |
|
74 | - * @since 19.0.0 |
|
75 | - */ |
|
76 | - public function getUid(): ?string { |
|
77 | - return $this->uid; |
|
78 | - } |
|
72 | + /** |
|
73 | + * @return string|null |
|
74 | + * @since 19.0.0 |
|
75 | + */ |
|
76 | + public function getUid(): ?string { |
|
77 | + return $this->uid; |
|
78 | + } |
|
79 | 79 | |
80 | - /** |
|
81 | - * Set the uid of the person interacted with, if known |
|
82 | - * |
|
83 | - * @param string $uid |
|
84 | - * |
|
85 | - * @return self |
|
86 | - * @since 19.0.0 |
|
87 | - */ |
|
88 | - public function setUid(string $uid): self { |
|
89 | - $this->uid = $uid; |
|
90 | - return $this; |
|
91 | - } |
|
80 | + /** |
|
81 | + * Set the uid of the person interacted with, if known |
|
82 | + * |
|
83 | + * @param string $uid |
|
84 | + * |
|
85 | + * @return self |
|
86 | + * @since 19.0.0 |
|
87 | + */ |
|
88 | + public function setUid(string $uid): self { |
|
89 | + $this->uid = $uid; |
|
90 | + return $this; |
|
91 | + } |
|
92 | 92 | |
93 | - /** |
|
94 | - * @return string|null |
|
95 | - * @since 19.0.0 |
|
96 | - */ |
|
97 | - public function getEmail(): ?string { |
|
98 | - return $this->email; |
|
99 | - } |
|
93 | + /** |
|
94 | + * @return string|null |
|
95 | + * @since 19.0.0 |
|
96 | + */ |
|
97 | + public function getEmail(): ?string { |
|
98 | + return $this->email; |
|
99 | + } |
|
100 | 100 | |
101 | - /** |
|
102 | - * Set the email of the person interacted with, if known |
|
103 | - * |
|
104 | - * @param string $email |
|
105 | - * |
|
106 | - * @return self |
|
107 | - * @since 19.0.0 |
|
108 | - */ |
|
109 | - public function setEmail(string $email): self { |
|
110 | - $this->email = $email; |
|
111 | - return $this; |
|
112 | - } |
|
101 | + /** |
|
102 | + * Set the email of the person interacted with, if known |
|
103 | + * |
|
104 | + * @param string $email |
|
105 | + * |
|
106 | + * @return self |
|
107 | + * @since 19.0.0 |
|
108 | + */ |
|
109 | + public function setEmail(string $email): self { |
|
110 | + $this->email = $email; |
|
111 | + return $this; |
|
112 | + } |
|
113 | 113 | |
114 | - /** |
|
115 | - * @return string|null |
|
116 | - * @since 19.0.0 |
|
117 | - */ |
|
118 | - public function getFederatedCloudId(): ?string { |
|
119 | - return $this->federatedCloudId; |
|
120 | - } |
|
114 | + /** |
|
115 | + * @return string|null |
|
116 | + * @since 19.0.0 |
|
117 | + */ |
|
118 | + public function getFederatedCloudId(): ?string { |
|
119 | + return $this->federatedCloudId; |
|
120 | + } |
|
121 | 121 | |
122 | - /** |
|
123 | - * Set the federated cloud of the person interacted with, if known |
|
124 | - * |
|
125 | - * @param string $federatedCloudId |
|
126 | - * |
|
127 | - * @return self |
|
128 | - * @since 19.0.0 |
|
129 | - */ |
|
130 | - public function setFederatedCloudId(string $federatedCloudId): self { |
|
131 | - $this->federatedCloudId = $federatedCloudId; |
|
132 | - return $this; |
|
133 | - } |
|
122 | + /** |
|
123 | + * Set the federated cloud of the person interacted with, if known |
|
124 | + * |
|
125 | + * @param string $federatedCloudId |
|
126 | + * |
|
127 | + * @return self |
|
128 | + * @since 19.0.0 |
|
129 | + */ |
|
130 | + public function setFederatedCloudId(string $federatedCloudId): self { |
|
131 | + $this->federatedCloudId = $federatedCloudId; |
|
132 | + return $this; |
|
133 | + } |
|
134 | 134 | } |
@@ -41,77 +41,77 @@ |
||
41 | 41 | * @since 6.0.0 |
42 | 42 | */ |
43 | 43 | interface ISession { |
44 | - /** |
|
45 | - * Set a value in the session |
|
46 | - * |
|
47 | - * @param string $key |
|
48 | - * @param mixed $value |
|
49 | - * @since 6.0.0 |
|
50 | - */ |
|
51 | - public function set(string $key, $value); |
|
44 | + /** |
|
45 | + * Set a value in the session |
|
46 | + * |
|
47 | + * @param string $key |
|
48 | + * @param mixed $value |
|
49 | + * @since 6.0.0 |
|
50 | + */ |
|
51 | + public function set(string $key, $value); |
|
52 | 52 | |
53 | - /** |
|
54 | - * Get a value from the session |
|
55 | - * |
|
56 | - * @param string $key |
|
57 | - * @return mixed should return null if $key does not exist |
|
58 | - * @since 6.0.0 |
|
59 | - */ |
|
60 | - public function get(string $key); |
|
53 | + /** |
|
54 | + * Get a value from the session |
|
55 | + * |
|
56 | + * @param string $key |
|
57 | + * @return mixed should return null if $key does not exist |
|
58 | + * @since 6.0.0 |
|
59 | + */ |
|
60 | + public function get(string $key); |
|
61 | 61 | |
62 | - /** |
|
63 | - * Check if a named key exists in the session |
|
64 | - * |
|
65 | - * @param string $key |
|
66 | - * @return bool |
|
67 | - * @since 6.0.0 |
|
68 | - */ |
|
69 | - public function exists(string $key): bool; |
|
62 | + /** |
|
63 | + * Check if a named key exists in the session |
|
64 | + * |
|
65 | + * @param string $key |
|
66 | + * @return bool |
|
67 | + * @since 6.0.0 |
|
68 | + */ |
|
69 | + public function exists(string $key): bool; |
|
70 | 70 | |
71 | - /** |
|
72 | - * Remove a $key/$value pair from the session |
|
73 | - * |
|
74 | - * @param string $key |
|
75 | - * @since 6.0.0 |
|
76 | - */ |
|
77 | - public function remove(string $key); |
|
71 | + /** |
|
72 | + * Remove a $key/$value pair from the session |
|
73 | + * |
|
74 | + * @param string $key |
|
75 | + * @since 6.0.0 |
|
76 | + */ |
|
77 | + public function remove(string $key); |
|
78 | 78 | |
79 | - /** |
|
80 | - * Reset and recreate the session |
|
81 | - * @since 6.0.0 |
|
82 | - */ |
|
83 | - public function clear(); |
|
79 | + /** |
|
80 | + * Reset and recreate the session |
|
81 | + * @since 6.0.0 |
|
82 | + */ |
|
83 | + public function clear(); |
|
84 | 84 | |
85 | - /** |
|
86 | - * Reopen a session for writing again |
|
87 | - * |
|
88 | - * @return bool true if the session was actually reopened, otherwise false |
|
89 | - * @since 25.0.0 |
|
90 | - */ |
|
91 | - public function reopen(): bool; |
|
85 | + /** |
|
86 | + * Reopen a session for writing again |
|
87 | + * |
|
88 | + * @return bool true if the session was actually reopened, otherwise false |
|
89 | + * @since 25.0.0 |
|
90 | + */ |
|
91 | + public function reopen(): bool; |
|
92 | 92 | |
93 | - /** |
|
94 | - * Close the session and release the lock |
|
95 | - * @since 7.0.0 |
|
96 | - */ |
|
97 | - public function close(); |
|
93 | + /** |
|
94 | + * Close the session and release the lock |
|
95 | + * @since 7.0.0 |
|
96 | + */ |
|
97 | + public function close(); |
|
98 | 98 | |
99 | - /** |
|
100 | - * Wrapper around session_regenerate_id |
|
101 | - * |
|
102 | - * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
103 | - * @param bool $updateToken Wheater to update the associated auth token |
|
104 | - * @return void |
|
105 | - * @since 9.0.0, $updateToken added in 14.0.0 |
|
106 | - */ |
|
107 | - public function regenerateId(bool $deleteOldSession = true, bool $updateToken = false); |
|
99 | + /** |
|
100 | + * Wrapper around session_regenerate_id |
|
101 | + * |
|
102 | + * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
103 | + * @param bool $updateToken Wheater to update the associated auth token |
|
104 | + * @return void |
|
105 | + * @since 9.0.0, $updateToken added in 14.0.0 |
|
106 | + */ |
|
107 | + public function regenerateId(bool $deleteOldSession = true, bool $updateToken = false); |
|
108 | 108 | |
109 | - /** |
|
110 | - * Wrapper around session_id |
|
111 | - * |
|
112 | - * @return string |
|
113 | - * @throws SessionNotAvailableException |
|
114 | - * @since 9.1.0 |
|
115 | - */ |
|
116 | - public function getId(): string; |
|
109 | + /** |
|
110 | + * Wrapper around session_id |
|
111 | + * |
|
112 | + * @return string |
|
113 | + * @throws SessionNotAvailableException |
|
114 | + * @since 9.1.0 |
|
115 | + */ |
|
116 | + public function getId(): string; |
|
117 | 117 | } |