@@ -28,15 +28,15 @@ |
||
28 | 28 | * @since 11.0.0 |
29 | 29 | */ |
30 | 30 | interface IProvider { |
31 | - /** |
|
32 | - * @param string $language The language which should be used for translating, e.g. "en" |
|
33 | - * @param IEvent $event The current event which should be parsed |
|
34 | - * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one. |
|
35 | - * To do so, simply use setChildEvent($previousEvent) after setting the |
|
36 | - * combined subject on the current event. |
|
37 | - * @return IEvent |
|
38 | - * @throws \InvalidArgumentException Should be thrown if your provider does not know this event |
|
39 | - * @since 11.0.0 |
|
40 | - */ |
|
41 | - public function parse($language, IEvent $event, IEvent $previousEvent = null); |
|
31 | + /** |
|
32 | + * @param string $language The language which should be used for translating, e.g. "en" |
|
33 | + * @param IEvent $event The current event which should be parsed |
|
34 | + * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one. |
|
35 | + * To do so, simply use setChildEvent($previousEvent) after setting the |
|
36 | + * combined subject on the current event. |
|
37 | + * @return IEvent |
|
38 | + * @throws \InvalidArgumentException Should be thrown if your provider does not know this event |
|
39 | + * @since 11.0.0 |
|
40 | + */ |
|
41 | + public function parse($language, IEvent $event, IEvent $previousEvent = null); |
|
42 | 42 | } |
@@ -38,12 +38,12 @@ |
||
38 | 38 | * @since 6.0.0 |
39 | 39 | */ |
40 | 40 | interface IConsumer { |
41 | - /** |
|
42 | - * @param IEvent $event |
|
43 | - * @return null |
|
44 | - * @since 6.0.0 |
|
45 | - * @since 8.2.0 Replaced the parameters with an IEvent object |
|
46 | - */ |
|
47 | - public function receive(IEvent $event); |
|
41 | + /** |
|
42 | + * @param IEvent $event |
|
43 | + * @return null |
|
44 | + * @since 6.0.0 |
|
45 | + * @since 8.2.0 Replaced the parameters with an IEvent object |
|
46 | + */ |
|
47 | + public function receive(IEvent $event); |
|
48 | 48 | } |
49 | 49 |
@@ -29,12 +29,12 @@ |
||
29 | 29 | * @since 8.2.2 |
30 | 30 | */ |
31 | 31 | interface IMemcacheTTL extends IMemcache { |
32 | - /** |
|
33 | - * Set the ttl for an existing value |
|
34 | - * |
|
35 | - * @param string $key |
|
36 | - * @param int $ttl time to live in seconds |
|
37 | - * @since 8.2.2 |
|
38 | - */ |
|
39 | - public function setTTL($key, $ttl); |
|
32 | + /** |
|
33 | + * Set the ttl for an existing value |
|
34 | + * |
|
35 | + * @param string $key |
|
36 | + * @param int $ttl time to live in seconds |
|
37 | + * @since 8.2.2 |
|
38 | + */ |
|
39 | + public function setTTL($key, $ttl); |
|
40 | 40 | } |
@@ -30,10 +30,10 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IDateTimeZone { |
33 | - /** |
|
34 | - * @param bool|int $timestamp |
|
35 | - * @return \DateTimeZone |
|
36 | - * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
37 | - */ |
|
38 | - public function getTimeZone($timestamp = false); |
|
33 | + /** |
|
34 | + * @param bool|int $timestamp |
|
35 | + * @return \DateTimeZone |
|
36 | + * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
37 | + */ |
|
38 | + public function getTimeZone($timestamp = false); |
|
39 | 39 | } |
@@ -68,7 +68,7 @@ |
||
68 | 68 | * remove all user backends |
69 | 69 | * @since 8.0.0 |
70 | 70 | */ |
71 | - public function clearBackends() ; |
|
71 | + public function clearBackends(); |
|
72 | 72 | |
73 | 73 | /** |
74 | 74 | * get a user by user id |
@@ -48,145 +48,145 @@ |
||
48 | 48 | * @since 8.0.0 |
49 | 49 | */ |
50 | 50 | interface IUserManager { |
51 | - /** |
|
52 | - * register a user backend |
|
53 | - * |
|
54 | - * @param \OCP\UserInterface $backend |
|
55 | - * @since 8.0.0 |
|
56 | - */ |
|
57 | - public function registerBackend($backend); |
|
58 | - |
|
59 | - /** |
|
60 | - * Get the active backends |
|
61 | - * @return \OCP\UserInterface[] |
|
62 | - * @since 8.0.0 |
|
63 | - */ |
|
64 | - public function getBackends(); |
|
65 | - |
|
66 | - /** |
|
67 | - * remove a user backend |
|
68 | - * |
|
69 | - * @param \OCP\UserInterface $backend |
|
70 | - * @since 8.0.0 |
|
71 | - */ |
|
72 | - public function removeBackend($backend); |
|
73 | - |
|
74 | - /** |
|
75 | - * remove all user backends |
|
76 | - * @since 8.0.0 |
|
77 | - */ |
|
78 | - public function clearBackends() ; |
|
79 | - |
|
80 | - /** |
|
81 | - * get a user by user id |
|
82 | - * |
|
83 | - * @param string $uid |
|
84 | - * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
85 | - * @since 8.0.0 |
|
86 | - */ |
|
87 | - public function get($uid); |
|
88 | - |
|
89 | - /** |
|
90 | - * check if a user exists |
|
91 | - * |
|
92 | - * @param string $uid |
|
93 | - * @return bool |
|
94 | - * @since 8.0.0 |
|
95 | - */ |
|
96 | - public function userExists($uid); |
|
97 | - |
|
98 | - /** |
|
99 | - * Check if the password is valid for the user |
|
100 | - * |
|
101 | - * @param string $loginName |
|
102 | - * @param string $password |
|
103 | - * @return mixed the User object on success, false otherwise |
|
104 | - * @since 8.0.0 |
|
105 | - */ |
|
106 | - public function checkPassword($loginName, $password); |
|
107 | - |
|
108 | - /** |
|
109 | - * search by user id |
|
110 | - * |
|
111 | - * @param string $pattern |
|
112 | - * @param int $limit |
|
113 | - * @param int $offset |
|
114 | - * @return \OCP\IUser[] |
|
115 | - * @since 8.0.0 |
|
116 | - */ |
|
117 | - public function search($pattern, $limit = null, $offset = null); |
|
118 | - |
|
119 | - /** |
|
120 | - * search by displayName |
|
121 | - * |
|
122 | - * @param string $pattern |
|
123 | - * @param int $limit |
|
124 | - * @param int $offset |
|
125 | - * @return \OCP\IUser[] |
|
126 | - * @since 8.0.0 |
|
127 | - */ |
|
128 | - public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
129 | - |
|
130 | - /** |
|
131 | - * @param string $uid |
|
132 | - * @param string $password |
|
133 | - * @throws \InvalidArgumentException |
|
134 | - * @return bool|\OCP\IUser the created user or false |
|
135 | - * @since 8.0.0 |
|
136 | - */ |
|
137 | - public function createUser($uid, $password); |
|
138 | - |
|
139 | - /** |
|
140 | - * @param string $uid |
|
141 | - * @param string $password |
|
142 | - * @param UserInterface $backend |
|
143 | - * @return IUser|null |
|
144 | - * @throws \InvalidArgumentException |
|
145 | - * @since 12.0.0 |
|
146 | - */ |
|
147 | - public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
148 | - |
|
149 | - /** |
|
150 | - * returns how many users per backend exist (if supported by backend) |
|
151 | - * |
|
152 | - * @return array an array of backend class as key and count number as value |
|
153 | - * @since 8.0.0 |
|
154 | - */ |
|
155 | - public function countUsers(); |
|
156 | - |
|
157 | - /** |
|
158 | - * @param \Closure $callback |
|
159 | - * @param string $search |
|
160 | - * @since 9.0.0 |
|
161 | - */ |
|
162 | - public function callForAllUsers(\Closure $callback, $search = ''); |
|
163 | - |
|
164 | - /** |
|
165 | - * returns how many users have logged in once |
|
166 | - * |
|
167 | - * @return int |
|
168 | - * @since 11.0.0 |
|
169 | - */ |
|
170 | - public function countDisabledUsers(); |
|
171 | - |
|
172 | - /** |
|
173 | - * returns how many users have logged in once |
|
174 | - * |
|
175 | - * @return int |
|
176 | - * @since 11.0.0 |
|
177 | - */ |
|
178 | - public function countSeenUsers(); |
|
179 | - |
|
180 | - /** |
|
181 | - * @param \Closure $callback |
|
182 | - * @since 11.0.0 |
|
183 | - */ |
|
184 | - public function callForSeenUsers(\Closure $callback); |
|
185 | - |
|
186 | - /** |
|
187 | - * @param string $email |
|
188 | - * @return IUser[] |
|
189 | - * @since 9.1.0 |
|
190 | - */ |
|
191 | - public function getByEmail($email); |
|
51 | + /** |
|
52 | + * register a user backend |
|
53 | + * |
|
54 | + * @param \OCP\UserInterface $backend |
|
55 | + * @since 8.0.0 |
|
56 | + */ |
|
57 | + public function registerBackend($backend); |
|
58 | + |
|
59 | + /** |
|
60 | + * Get the active backends |
|
61 | + * @return \OCP\UserInterface[] |
|
62 | + * @since 8.0.0 |
|
63 | + */ |
|
64 | + public function getBackends(); |
|
65 | + |
|
66 | + /** |
|
67 | + * remove a user backend |
|
68 | + * |
|
69 | + * @param \OCP\UserInterface $backend |
|
70 | + * @since 8.0.0 |
|
71 | + */ |
|
72 | + public function removeBackend($backend); |
|
73 | + |
|
74 | + /** |
|
75 | + * remove all user backends |
|
76 | + * @since 8.0.0 |
|
77 | + */ |
|
78 | + public function clearBackends() ; |
|
79 | + |
|
80 | + /** |
|
81 | + * get a user by user id |
|
82 | + * |
|
83 | + * @param string $uid |
|
84 | + * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
85 | + * @since 8.0.0 |
|
86 | + */ |
|
87 | + public function get($uid); |
|
88 | + |
|
89 | + /** |
|
90 | + * check if a user exists |
|
91 | + * |
|
92 | + * @param string $uid |
|
93 | + * @return bool |
|
94 | + * @since 8.0.0 |
|
95 | + */ |
|
96 | + public function userExists($uid); |
|
97 | + |
|
98 | + /** |
|
99 | + * Check if the password is valid for the user |
|
100 | + * |
|
101 | + * @param string $loginName |
|
102 | + * @param string $password |
|
103 | + * @return mixed the User object on success, false otherwise |
|
104 | + * @since 8.0.0 |
|
105 | + */ |
|
106 | + public function checkPassword($loginName, $password); |
|
107 | + |
|
108 | + /** |
|
109 | + * search by user id |
|
110 | + * |
|
111 | + * @param string $pattern |
|
112 | + * @param int $limit |
|
113 | + * @param int $offset |
|
114 | + * @return \OCP\IUser[] |
|
115 | + * @since 8.0.0 |
|
116 | + */ |
|
117 | + public function search($pattern, $limit = null, $offset = null); |
|
118 | + |
|
119 | + /** |
|
120 | + * search by displayName |
|
121 | + * |
|
122 | + * @param string $pattern |
|
123 | + * @param int $limit |
|
124 | + * @param int $offset |
|
125 | + * @return \OCP\IUser[] |
|
126 | + * @since 8.0.0 |
|
127 | + */ |
|
128 | + public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
129 | + |
|
130 | + /** |
|
131 | + * @param string $uid |
|
132 | + * @param string $password |
|
133 | + * @throws \InvalidArgumentException |
|
134 | + * @return bool|\OCP\IUser the created user or false |
|
135 | + * @since 8.0.0 |
|
136 | + */ |
|
137 | + public function createUser($uid, $password); |
|
138 | + |
|
139 | + /** |
|
140 | + * @param string $uid |
|
141 | + * @param string $password |
|
142 | + * @param UserInterface $backend |
|
143 | + * @return IUser|null |
|
144 | + * @throws \InvalidArgumentException |
|
145 | + * @since 12.0.0 |
|
146 | + */ |
|
147 | + public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
148 | + |
|
149 | + /** |
|
150 | + * returns how many users per backend exist (if supported by backend) |
|
151 | + * |
|
152 | + * @return array an array of backend class as key and count number as value |
|
153 | + * @since 8.0.0 |
|
154 | + */ |
|
155 | + public function countUsers(); |
|
156 | + |
|
157 | + /** |
|
158 | + * @param \Closure $callback |
|
159 | + * @param string $search |
|
160 | + * @since 9.0.0 |
|
161 | + */ |
|
162 | + public function callForAllUsers(\Closure $callback, $search = ''); |
|
163 | + |
|
164 | + /** |
|
165 | + * returns how many users have logged in once |
|
166 | + * |
|
167 | + * @return int |
|
168 | + * @since 11.0.0 |
|
169 | + */ |
|
170 | + public function countDisabledUsers(); |
|
171 | + |
|
172 | + /** |
|
173 | + * returns how many users have logged in once |
|
174 | + * |
|
175 | + * @return int |
|
176 | + * @since 11.0.0 |
|
177 | + */ |
|
178 | + public function countSeenUsers(); |
|
179 | + |
|
180 | + /** |
|
181 | + * @param \Closure $callback |
|
182 | + * @since 11.0.0 |
|
183 | + */ |
|
184 | + public function callForSeenUsers(\Closure $callback); |
|
185 | + |
|
186 | + /** |
|
187 | + * @param string $email |
|
188 | + * @return IUser[] |
|
189 | + * @since 9.1.0 |
|
190 | + */ |
|
191 | + public function getByEmail($email); |
|
192 | 192 | } |
@@ -31,9 +31,9 @@ |
||
31 | 31 | */ |
32 | 32 | interface ICommentsEventHandler { |
33 | 33 | |
34 | - /** |
|
35 | - * @param CommentsEvent $event |
|
36 | - * @since 11.0.0 |
|
37 | - */ |
|
38 | - public function handle(CommentsEvent $event); |
|
34 | + /** |
|
35 | + * @param CommentsEvent $event |
|
36 | + * @since 11.0.0 |
|
37 | + */ |
|
38 | + public function handle(CommentsEvent $event); |
|
39 | 39 | } |
@@ -61,7 +61,7 @@ |
||
61 | 61 | */ |
62 | 62 | public function addEntityCollection($name, \Closure $entityExistsFunction) { |
63 | 63 | if (isset($this->collections[$name])) { |
64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
64 | + throw new \OutOfBoundsException('Duplicate entity name "'.$name.'"'); |
|
65 | 65 | } |
66 | 66 | |
67 | 67 | $this->collections[$name] = $entityExistsFunction; |
@@ -32,46 +32,46 @@ |
||
32 | 32 | * @since 9.1.0 |
33 | 33 | */ |
34 | 34 | class CommentsEntityEvent extends Event { |
35 | - public const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
35 | + public const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - protected $event; |
|
39 | - /** @var \Closure[] */ |
|
40 | - protected $collections; |
|
37 | + /** @var string */ |
|
38 | + protected $event; |
|
39 | + /** @var \Closure[] */ |
|
40 | + protected $collections; |
|
41 | 41 | |
42 | - /** |
|
43 | - * DispatcherEvent constructor. |
|
44 | - * |
|
45 | - * @param string $event |
|
46 | - * @since 9.1.0 |
|
47 | - */ |
|
48 | - public function __construct($event) { |
|
49 | - $this->event = $event; |
|
50 | - $this->collections = []; |
|
51 | - } |
|
42 | + /** |
|
43 | + * DispatcherEvent constructor. |
|
44 | + * |
|
45 | + * @param string $event |
|
46 | + * @since 9.1.0 |
|
47 | + */ |
|
48 | + public function __construct($event) { |
|
49 | + $this->event = $event; |
|
50 | + $this->collections = []; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * @param string $name |
|
55 | - * @param \Closure $entityExistsFunction The closure should take one |
|
56 | - * argument, which is the id of the entity, that comments |
|
57 | - * should be handled for. The return should then be bool, |
|
58 | - * depending on whether comments are allowed (true) or not. |
|
59 | - * @throws \OutOfBoundsException when the entity name is already taken |
|
60 | - * @since 9.1.0 |
|
61 | - */ |
|
62 | - public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
63 | - if (isset($this->collections[$name])) { |
|
64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
65 | - } |
|
53 | + /** |
|
54 | + * @param string $name |
|
55 | + * @param \Closure $entityExistsFunction The closure should take one |
|
56 | + * argument, which is the id of the entity, that comments |
|
57 | + * should be handled for. The return should then be bool, |
|
58 | + * depending on whether comments are allowed (true) or not. |
|
59 | + * @throws \OutOfBoundsException when the entity name is already taken |
|
60 | + * @since 9.1.0 |
|
61 | + */ |
|
62 | + public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
63 | + if (isset($this->collections[$name])) { |
|
64 | + throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
65 | + } |
|
66 | 66 | |
67 | - $this->collections[$name] = $entityExistsFunction; |
|
68 | - } |
|
67 | + $this->collections[$name] = $entityExistsFunction; |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * @return \Closure[] |
|
72 | - * @since 9.1.0 |
|
73 | - */ |
|
74 | - public function getEntityCollections() { |
|
75 | - return $this->collections; |
|
76 | - } |
|
70 | + /** |
|
71 | + * @return \Closure[] |
|
72 | + * @since 9.1.0 |
|
73 | + */ |
|
74 | + public function getEntityCollections() { |
|
75 | + return $this->collections; |
|
76 | + } |
|
77 | 77 | } |
@@ -36,19 +36,19 @@ |
||
36 | 36 | */ |
37 | 37 | interface ICommentsManagerFactory { |
38 | 38 | |
39 | - /** |
|
40 | - * Constructor for the comments manager factory |
|
41 | - * |
|
42 | - * @param IServerContainer $serverContainer server container |
|
43 | - * @since 9.0.0 |
|
44 | - */ |
|
45 | - public function __construct(IServerContainer $serverContainer); |
|
39 | + /** |
|
40 | + * Constructor for the comments manager factory |
|
41 | + * |
|
42 | + * @param IServerContainer $serverContainer server container |
|
43 | + * @since 9.0.0 |
|
44 | + */ |
|
45 | + public function __construct(IServerContainer $serverContainer); |
|
46 | 46 | |
47 | - /** |
|
48 | - * creates and returns an instance of the ICommentsManager |
|
49 | - * |
|
50 | - * @return ICommentsManager |
|
51 | - * @since 9.0.0 |
|
52 | - */ |
|
53 | - public function getManager(); |
|
47 | + /** |
|
48 | + * creates and returns an instance of the ICommentsManager |
|
49 | + * |
|
50 | + * @return ICommentsManager |
|
51 | + * @since 9.0.0 |
|
52 | + */ |
|
53 | + public function getManager(); |
|
54 | 54 | } |
@@ -30,51 +30,51 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface ICertificate { |
33 | - /** |
|
34 | - * @return string |
|
35 | - * @since 8.0.0 |
|
36 | - */ |
|
37 | - public function getName(); |
|
33 | + /** |
|
34 | + * @return string |
|
35 | + * @since 8.0.0 |
|
36 | + */ |
|
37 | + public function getName(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string |
|
41 | - * @since 8.0.0 |
|
42 | - */ |
|
43 | - public function getCommonName(); |
|
39 | + /** |
|
40 | + * @return string |
|
41 | + * @since 8.0.0 |
|
42 | + */ |
|
43 | + public function getCommonName(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return string |
|
47 | - * @since 8.0.0 |
|
48 | - */ |
|
49 | - public function getOrganization(); |
|
45 | + /** |
|
46 | + * @return string |
|
47 | + * @since 8.0.0 |
|
48 | + */ |
|
49 | + public function getOrganization(); |
|
50 | 50 | |
51 | - /** |
|
52 | - * @return \DateTime |
|
53 | - * @since 8.0.0 |
|
54 | - */ |
|
55 | - public function getIssueDate(); |
|
51 | + /** |
|
52 | + * @return \DateTime |
|
53 | + * @since 8.0.0 |
|
54 | + */ |
|
55 | + public function getIssueDate(); |
|
56 | 56 | |
57 | - /** |
|
58 | - * @return \DateTime |
|
59 | - * @since 8.0.0 |
|
60 | - */ |
|
61 | - public function getExpireDate(); |
|
57 | + /** |
|
58 | + * @return \DateTime |
|
59 | + * @since 8.0.0 |
|
60 | + */ |
|
61 | + public function getExpireDate(); |
|
62 | 62 | |
63 | - /** |
|
64 | - * @return bool |
|
65 | - * @since 8.0.0 |
|
66 | - */ |
|
67 | - public function isExpired(); |
|
63 | + /** |
|
64 | + * @return bool |
|
65 | + * @since 8.0.0 |
|
66 | + */ |
|
67 | + public function isExpired(); |
|
68 | 68 | |
69 | - /** |
|
70 | - * @return string |
|
71 | - * @since 8.0.0 |
|
72 | - */ |
|
73 | - public function getIssuerName(); |
|
69 | + /** |
|
70 | + * @return string |
|
71 | + * @since 8.0.0 |
|
72 | + */ |
|
73 | + public function getIssuerName(); |
|
74 | 74 | |
75 | - /** |
|
76 | - * @return string |
|
77 | - * @since 8.0.0 |
|
78 | - */ |
|
79 | - public function getIssuerOrganization(); |
|
75 | + /** |
|
76 | + * @return string |
|
77 | + * @since 8.0.0 |
|
78 | + */ |
|
79 | + public function getIssuerOrganization(); |
|
80 | 80 | } |