@@ -29,13 +29,13 @@ |
||
29 | 29 | * @since 21.0.1 |
30 | 30 | */ |
31 | 31 | interface ISearchKnownUsersBackend { |
32 | - /** |
|
33 | - * @param string $searcher |
|
34 | - * @param string $pattern |
|
35 | - * @param int|null $limit |
|
36 | - * @param int|null $offset |
|
37 | - * @return array |
|
38 | - * @since 21.0.1 |
|
39 | - */ |
|
40 | - public function searchKnownUsersByDisplayName(string $searcher, string $pattern, ?int $limit = null, ?int $offset = null): array; |
|
32 | + /** |
|
33 | + * @param string $searcher |
|
34 | + * @param string $pattern |
|
35 | + * @param int|null $limit |
|
36 | + * @param int|null $offset |
|
37 | + * @return array |
|
38 | + * @since 21.0.1 |
|
39 | + */ |
|
40 | + public function searchKnownUsersByDisplayName(string $searcher, string $pattern, ?int $limit = null, ?int $offset = null): array; |
|
41 | 41 | } |
@@ -29,11 +29,11 @@ |
||
29 | 29 | * @since 14.0.0 |
30 | 30 | */ |
31 | 31 | interface IProvideAvatarBackend { |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid |
|
36 | - * @return bool |
|
37 | - */ |
|
38 | - public function canChangeAvatar(string $uid): bool; |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid |
|
36 | + * @return bool |
|
37 | + */ |
|
38 | + public function canChangeAvatar(string $uid): bool; |
|
39 | 39 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | * @since 14.0.0 |
30 | 30 | */ |
31 | 31 | interface ICreateUserBackend { |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid The username of the user to create |
|
36 | - * @param string $password The password of the new user |
|
37 | - * @return bool |
|
38 | - */ |
|
39 | - public function createUser(string $uid, string $password): bool; |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid The username of the user to create |
|
36 | + * @param string $password The password of the new user |
|
37 | + * @return bool |
|
38 | + */ |
|
39 | + public function createUser(string $uid, string $password): bool; |
|
40 | 40 | } |
@@ -29,8 +29,8 @@ |
||
29 | 29 | * @since 15.0.0 |
30 | 30 | */ |
31 | 31 | interface IPasswordConfirmationBackend { |
32 | - /** |
|
33 | - * @since 15.0.0 |
|
34 | - */ |
|
35 | - public function canConfirmPassword(string $uid): bool; |
|
32 | + /** |
|
33 | + * @since 15.0.0 |
|
34 | + */ |
|
35 | + public function canConfirmPassword(string $uid): bool; |
|
36 | 36 | } |
@@ -31,26 +31,26 @@ |
||
31 | 31 | * @since 18.0.0 |
32 | 32 | */ |
33 | 33 | interface IBroadcastEvent { |
34 | - /** |
|
35 | - * @return string the name of the event |
|
36 | - * @since 18.0.0 |
|
37 | - */ |
|
38 | - public function getName(): string; |
|
34 | + /** |
|
35 | + * @return string the name of the event |
|
36 | + * @since 18.0.0 |
|
37 | + */ |
|
38 | + public function getName(): string; |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return string[] |
|
42 | - * @since 18.0.0 |
|
43 | - */ |
|
44 | - public function getUids(): array; |
|
40 | + /** |
|
41 | + * @return string[] |
|
42 | + * @since 18.0.0 |
|
43 | + */ |
|
44 | + public function getUids(): array; |
|
45 | 45 | |
46 | - /** |
|
47 | - * @return JsonSerializable the data to be sent to the client |
|
48 | - * @since 18.0.0 |
|
49 | - */ |
|
50 | - public function getPayload(): JsonSerializable; |
|
46 | + /** |
|
47 | + * @return JsonSerializable the data to be sent to the client |
|
48 | + * @since 18.0.0 |
|
49 | + */ |
|
50 | + public function getPayload(): JsonSerializable; |
|
51 | 51 | |
52 | - /** |
|
53 | - * @since 18.0.0 |
|
54 | - */ |
|
55 | - public function setBroadcasted(): void; |
|
52 | + /** |
|
53 | + * @since 18.0.0 |
|
54 | + */ |
|
55 | + public function setBroadcasted(): void; |
|
56 | 56 | } |
@@ -27,13 +27,13 @@ |
||
27 | 27 | * @since 8.2.0 |
28 | 28 | */ |
29 | 29 | class SabrePluginException extends Exception { |
30 | - /** |
|
31 | - * Returns the HTTP statuscode for this exception |
|
32 | - * |
|
33 | - * @return int |
|
34 | - * @since 8.2.0 |
|
35 | - */ |
|
36 | - public function getHTTPCode() { |
|
37 | - return $this->code; |
|
38 | - } |
|
30 | + /** |
|
31 | + * Returns the HTTP statuscode for this exception |
|
32 | + * |
|
33 | + * @return int |
|
34 | + * @since 8.2.0 |
|
35 | + */ |
|
36 | + public function getHTTPCode() { |
|
37 | + return $this->code; |
|
38 | + } |
|
39 | 39 | } |
@@ -35,9 +35,9 @@ |
||
35 | 35 | * @since 26.0.0 |
36 | 36 | */ |
37 | 37 | interface IConditionalWidget extends IWidget { |
38 | - /** |
|
39 | - * @return bool Whether the widget is enabled and should be registered |
|
40 | - * @since 26.0.0 |
|
41 | - */ |
|
42 | - public function isEnabled(): bool; |
|
38 | + /** |
|
39 | + * @return bool Whether the widget is enabled and should be registered |
|
40 | + * @since 26.0.0 |
|
41 | + */ |
|
42 | + public function isEnabled(): bool; |
|
43 | 43 | } |
@@ -44,52 +44,52 @@ |
||
44 | 44 | * @since 21.0.0 |
45 | 45 | */ |
46 | 46 | interface IResult { |
47 | - /** |
|
48 | - * @return true |
|
49 | - * |
|
50 | - * @since 21.0.0 |
|
51 | - */ |
|
52 | - public function closeCursor(): bool; |
|
47 | + /** |
|
48 | + * @return true |
|
49 | + * |
|
50 | + * @since 21.0.0 |
|
51 | + */ |
|
52 | + public function closeCursor(): bool; |
|
53 | 53 | |
54 | - /** |
|
55 | - * @param int $fetchMode |
|
56 | - * |
|
57 | - * @return mixed |
|
58 | - * |
|
59 | - * @since 21.0.0 |
|
60 | - */ |
|
61 | - public function fetch(int $fetchMode = PDO::FETCH_ASSOC); |
|
54 | + /** |
|
55 | + * @param int $fetchMode |
|
56 | + * |
|
57 | + * @return mixed |
|
58 | + * |
|
59 | + * @since 21.0.0 |
|
60 | + */ |
|
61 | + public function fetch(int $fetchMode = PDO::FETCH_ASSOC); |
|
62 | 62 | |
63 | - /** |
|
64 | - * @param int $fetchMode (one of PDO::FETCH_ASSOC, PDO::FETCH_NUM or PDO::FETCH_COLUMN (2, 3 or 7) |
|
65 | - * |
|
66 | - * @return mixed[] |
|
67 | - * |
|
68 | - * @since 21.0.0 |
|
69 | - */ |
|
70 | - public function fetchAll(int $fetchMode = PDO::FETCH_ASSOC): array; |
|
63 | + /** |
|
64 | + * @param int $fetchMode (one of PDO::FETCH_ASSOC, PDO::FETCH_NUM or PDO::FETCH_COLUMN (2, 3 or 7) |
|
65 | + * |
|
66 | + * @return mixed[] |
|
67 | + * |
|
68 | + * @since 21.0.0 |
|
69 | + */ |
|
70 | + public function fetchAll(int $fetchMode = PDO::FETCH_ASSOC): array; |
|
71 | 71 | |
72 | - /** |
|
73 | - * @return mixed |
|
74 | - * |
|
75 | - * @since 21.0.0 |
|
76 | - * @deprecated 21.0.0 use \OCP\DB\IResult::fetchOne |
|
77 | - */ |
|
78 | - public function fetchColumn(); |
|
72 | + /** |
|
73 | + * @return mixed |
|
74 | + * |
|
75 | + * @since 21.0.0 |
|
76 | + * @deprecated 21.0.0 use \OCP\DB\IResult::fetchOne |
|
77 | + */ |
|
78 | + public function fetchColumn(); |
|
79 | 79 | |
80 | - /** |
|
81 | - * Returns the first value of the next row of the result or FALSE if there are no more rows. |
|
82 | - * |
|
83 | - * @return false|mixed |
|
84 | - * |
|
85 | - * @since 21.0.0 |
|
86 | - */ |
|
87 | - public function fetchOne(); |
|
80 | + /** |
|
81 | + * Returns the first value of the next row of the result or FALSE if there are no more rows. |
|
82 | + * |
|
83 | + * @return false|mixed |
|
84 | + * |
|
85 | + * @since 21.0.0 |
|
86 | + */ |
|
87 | + public function fetchOne(); |
|
88 | 88 | |
89 | - /** |
|
90 | - * @return int |
|
91 | - * |
|
92 | - * @since 21.0.0 |
|
93 | - */ |
|
94 | - public function rowCount(): int; |
|
89 | + /** |
|
90 | + * @return int |
|
91 | + * |
|
92 | + * @since 21.0.0 |
|
93 | + */ |
|
94 | + public function rowCount(): int; |
|
95 | 95 | } |
@@ -42,94 +42,94 @@ |
||
42 | 42 | * @since 21.0.0 |
43 | 43 | */ |
44 | 44 | interface IPreparedStatement { |
45 | - /** |
|
46 | - * @return true |
|
47 | - * |
|
48 | - * @since 21.0.0 |
|
49 | - * @deprecated 21.0.0 use \OCP\DB\IResult::closeCursor on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
50 | - */ |
|
51 | - public function closeCursor(): bool; |
|
45 | + /** |
|
46 | + * @return true |
|
47 | + * |
|
48 | + * @since 21.0.0 |
|
49 | + * @deprecated 21.0.0 use \OCP\DB\IResult::closeCursor on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
50 | + */ |
|
51 | + public function closeCursor(): bool; |
|
52 | 52 | |
53 | - /** |
|
54 | - * @param int $fetchMode |
|
55 | - * |
|
56 | - * @return mixed |
|
57 | - * |
|
58 | - * @since 21.0.0 |
|
59 | - * @deprecated 21.0.0 use \OCP\DB\IResult::fetch on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
60 | - */ |
|
61 | - public function fetch(int $fetchMode = PDO::FETCH_ASSOC); |
|
53 | + /** |
|
54 | + * @param int $fetchMode |
|
55 | + * |
|
56 | + * @return mixed |
|
57 | + * |
|
58 | + * @since 21.0.0 |
|
59 | + * @deprecated 21.0.0 use \OCP\DB\IResult::fetch on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
60 | + */ |
|
61 | + public function fetch(int $fetchMode = PDO::FETCH_ASSOC); |
|
62 | 62 | |
63 | - /** |
|
64 | - * @param int $fetchMode |
|
65 | - * |
|
66 | - * @return mixed[] |
|
67 | - * |
|
68 | - * @since 21.0.0 |
|
69 | - * @deprecated 21.0.0 use \OCP\DB\IResult::fetchAll on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
70 | - */ |
|
71 | - public function fetchAll(int $fetchMode = PDO::FETCH_ASSOC); |
|
63 | + /** |
|
64 | + * @param int $fetchMode |
|
65 | + * |
|
66 | + * @return mixed[] |
|
67 | + * |
|
68 | + * @since 21.0.0 |
|
69 | + * @deprecated 21.0.0 use \OCP\DB\IResult::fetchAll on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
70 | + */ |
|
71 | + public function fetchAll(int $fetchMode = PDO::FETCH_ASSOC); |
|
72 | 72 | |
73 | - /** |
|
74 | - * @return mixed |
|
75 | - * |
|
76 | - * @since 21.0.0 |
|
77 | - * @deprecated 21.0.0 use \OCP\DB\IResult::fetchColumn on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
78 | - */ |
|
79 | - public function fetchColumn(); |
|
73 | + /** |
|
74 | + * @return mixed |
|
75 | + * |
|
76 | + * @since 21.0.0 |
|
77 | + * @deprecated 21.0.0 use \OCP\DB\IResult::fetchColumn on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
78 | + */ |
|
79 | + public function fetchColumn(); |
|
80 | 80 | |
81 | - /** |
|
82 | - * @return mixed |
|
83 | - * |
|
84 | - * @since 21.0.0 |
|
85 | - * @deprecated 21.0.0 use \OCP\DB\IResult::fetchOne on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
86 | - */ |
|
87 | - public function fetchOne(); |
|
81 | + /** |
|
82 | + * @return mixed |
|
83 | + * |
|
84 | + * @since 21.0.0 |
|
85 | + * @deprecated 21.0.0 use \OCP\DB\IResult::fetchOne on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
86 | + */ |
|
87 | + public function fetchOne(); |
|
88 | 88 | |
89 | - /** |
|
90 | - * @param int|string $param |
|
91 | - * @param mixed $value |
|
92 | - * @param int $type |
|
93 | - * |
|
94 | - * @return bool |
|
95 | - * |
|
96 | - * @throws Exception |
|
97 | - * |
|
98 | - * @since 21.0.0 |
|
99 | - */ |
|
100 | - public function bindValue($param, $value, $type = ParameterType::STRING): bool; |
|
89 | + /** |
|
90 | + * @param int|string $param |
|
91 | + * @param mixed $value |
|
92 | + * @param int $type |
|
93 | + * |
|
94 | + * @return bool |
|
95 | + * |
|
96 | + * @throws Exception |
|
97 | + * |
|
98 | + * @since 21.0.0 |
|
99 | + */ |
|
100 | + public function bindValue($param, $value, $type = ParameterType::STRING): bool; |
|
101 | 101 | |
102 | - /** |
|
103 | - * @param int|string $param |
|
104 | - * @param mixed $variable |
|
105 | - * @param int $type |
|
106 | - * @param int|null $length |
|
107 | - * |
|
108 | - * @return bool |
|
109 | - * |
|
110 | - * @throws Exception |
|
111 | - * |
|
112 | - * @since 21.0.0 |
|
113 | - */ |
|
114 | - public function bindParam($param, &$variable, $type = ParameterType::STRING, $length = null): bool; |
|
102 | + /** |
|
103 | + * @param int|string $param |
|
104 | + * @param mixed $variable |
|
105 | + * @param int $type |
|
106 | + * @param int|null $length |
|
107 | + * |
|
108 | + * @return bool |
|
109 | + * |
|
110 | + * @throws Exception |
|
111 | + * |
|
112 | + * @since 21.0.0 |
|
113 | + */ |
|
114 | + public function bindParam($param, &$variable, $type = ParameterType::STRING, $length = null): bool; |
|
115 | 115 | |
116 | - /** |
|
117 | - * @param mixed[]|null $params |
|
118 | - * |
|
119 | - * @return IResult |
|
120 | - * |
|
121 | - * @since 21.0.0 |
|
122 | - * @throws Exception |
|
123 | - */ |
|
124 | - public function execute($params = null): IResult; |
|
116 | + /** |
|
117 | + * @param mixed[]|null $params |
|
118 | + * |
|
119 | + * @return IResult |
|
120 | + * |
|
121 | + * @since 21.0.0 |
|
122 | + * @throws Exception |
|
123 | + */ |
|
124 | + public function execute($params = null): IResult; |
|
125 | 125 | |
126 | - /** |
|
127 | - * @return int |
|
128 | - * |
|
129 | - * @since 21.0.0 |
|
130 | - * |
|
131 | - * @throws Exception |
|
132 | - * @deprecated 21.0.0 use \OCP\DB\IResult::rowCount on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
133 | - */ |
|
134 | - public function rowCount(): int; |
|
126 | + /** |
|
127 | + * @return int |
|
128 | + * |
|
129 | + * @since 21.0.0 |
|
130 | + * |
|
131 | + * @throws Exception |
|
132 | + * @deprecated 21.0.0 use \OCP\DB\IResult::rowCount on the \OCP\DB\IResult returned by \OCP\IDBConnection::prepare |
|
133 | + */ |
|
134 | + public function rowCount(): int; |
|
135 | 135 | } |