@@ -29,19 +29,19 @@ |
||
29 | 29 | * @deprecated 23.0.0 |
30 | 30 | */ |
31 | 31 | interface ICredentials { |
32 | - /** |
|
33 | - * @return string |
|
34 | - * |
|
35 | - * @since 13.0.0 |
|
36 | - * @deprecated 23.0.0 |
|
37 | - */ |
|
38 | - public function getUsername(); |
|
32 | + /** |
|
33 | + * @return string |
|
34 | + * |
|
35 | + * @since 13.0.0 |
|
36 | + * @deprecated 23.0.0 |
|
37 | + */ |
|
38 | + public function getUsername(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return string |
|
42 | - * |
|
43 | - * @since 13.0.0 |
|
44 | - * @deprecated 23.0.0 |
|
45 | - */ |
|
46 | - public function getPassword(); |
|
40 | + /** |
|
41 | + * @return string |
|
42 | + * |
|
43 | + * @since 13.0.0 |
|
44 | + * @deprecated 23.0.0 |
|
45 | + */ |
|
46 | + public function getPassword(); |
|
47 | 47 | } |
@@ -27,12 +27,12 @@ |
||
27 | 27 | * @deprecated 23.0.0 |
28 | 28 | */ |
29 | 29 | interface IInstanceFactory { |
30 | - /** |
|
31 | - * @param string $url |
|
32 | - * @return IInstance |
|
33 | - * |
|
34 | - * @since 13.0.0 |
|
35 | - * @deprecated 23.0.0 |
|
36 | - */ |
|
37 | - public function getInstance($url); |
|
30 | + /** |
|
31 | + * @param string $url |
|
32 | + * @return IInstance |
|
33 | + * |
|
34 | + * @since 13.0.0 |
|
35 | + * @deprecated 23.0.0 |
|
36 | + */ |
|
37 | + public function getInstance($url); |
|
38 | 38 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | * @deprecated 23.0.0 |
30 | 30 | */ |
31 | 31 | interface IUserApi { |
32 | - /** |
|
33 | - * @param string $userId |
|
34 | - * @return IUser |
|
35 | - * |
|
36 | - * @since 13.0.0 |
|
37 | - * @deprecated 23.0.0 |
|
38 | - */ |
|
39 | - public function getUser($userId); |
|
32 | + /** |
|
33 | + * @param string $userId |
|
34 | + * @return IUser |
|
35 | + * |
|
36 | + * @since 13.0.0 |
|
37 | + * @deprecated 23.0.0 |
|
38 | + */ |
|
39 | + public function getUser($userId); |
|
40 | 40 | } |
@@ -27,11 +27,11 @@ |
||
27 | 27 | * @deprecated 23.0.0 |
28 | 28 | */ |
29 | 29 | interface ICapabilitiesApi { |
30 | - /** |
|
31 | - * @return array The capabilities in the form of [$appId => [$capability => $value]] |
|
32 | - * |
|
33 | - * @since 13.0.0 |
|
34 | - * @deprecated 23.0.0 |
|
35 | - */ |
|
36 | - public function getCapabilities(); |
|
30 | + /** |
|
31 | + * @return array The capabilities in the form of [$appId => [$capability => $value]] |
|
32 | + * |
|
33 | + * @since 13.0.0 |
|
34 | + * @deprecated 23.0.0 |
|
35 | + */ |
|
36 | + public function getCapabilities(); |
|
37 | 37 | } |
@@ -30,13 +30,13 @@ |
||
30 | 30 | * @deprecated 23.0.0 |
31 | 31 | */ |
32 | 32 | interface IApiFactory { |
33 | - /** |
|
34 | - * @param IInstance $instance |
|
35 | - * @param ICredentials $credentials |
|
36 | - * @return IApiCollection |
|
37 | - * |
|
38 | - * @since 13.0.0 |
|
39 | - * @deprecated 23.0.0 |
|
40 | - */ |
|
41 | - public function getApiCollection(IInstance $instance, ICredentials $credentials); |
|
33 | + /** |
|
34 | + * @param IInstance $instance |
|
35 | + * @param ICredentials $credentials |
|
36 | + * @return IApiCollection |
|
37 | + * |
|
38 | + * @since 13.0.0 |
|
39 | + * @deprecated 23.0.0 |
|
40 | + */ |
|
41 | + public function getApiCollection(IInstance $instance, ICredentials $credentials); |
|
42 | 42 | } |
@@ -29,19 +29,19 @@ |
||
29 | 29 | * @deprecated 23.0.0 |
30 | 30 | */ |
31 | 31 | interface IApiCollection { |
32 | - /** |
|
33 | - * @return IUserApi |
|
34 | - * |
|
35 | - * @since 13.0.0 |
|
36 | - * @deprecated 23.0.0 |
|
37 | - */ |
|
38 | - public function getUserApi(); |
|
32 | + /** |
|
33 | + * @return IUserApi |
|
34 | + * |
|
35 | + * @since 13.0.0 |
|
36 | + * @deprecated 23.0.0 |
|
37 | + */ |
|
38 | + public function getUserApi(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return ICapabilitiesApi |
|
42 | - * |
|
43 | - * @since 13.0.0 |
|
44 | - * @deprecated 23.0.0 |
|
45 | - */ |
|
46 | - public function getCapabilitiesApi(); |
|
40 | + /** |
|
41 | + * @return ICapabilitiesApi |
|
42 | + * |
|
43 | + * @since 13.0.0 |
|
44 | + * @deprecated 23.0.0 |
|
45 | + */ |
|
46 | + public function getCapabilitiesApi(); |
|
47 | 47 | } |
@@ -31,75 +31,75 @@ |
||
31 | 31 | * @since 9.1 |
32 | 32 | */ |
33 | 33 | interface IOperation { |
34 | - /** |
|
35 | - * returns a translated name to be presented in the web interface |
|
36 | - * |
|
37 | - * Example: "Automated tagging" (en), "Aŭtomata etikedado" (eo) |
|
38 | - * |
|
39 | - * @since 18.0.0 |
|
40 | - */ |
|
41 | - public function getDisplayName(): string; |
|
34 | + /** |
|
35 | + * returns a translated name to be presented in the web interface |
|
36 | + * |
|
37 | + * Example: "Automated tagging" (en), "Aŭtomata etikedado" (eo) |
|
38 | + * |
|
39 | + * @since 18.0.0 |
|
40 | + */ |
|
41 | + public function getDisplayName(): string; |
|
42 | 42 | |
43 | - /** |
|
44 | - * returns a translated, descriptive text to be presented in the web interface. |
|
45 | - * |
|
46 | - * It should be short and precise. |
|
47 | - * |
|
48 | - * Example: "Tag based automatic deletion of files after a given time." (en) |
|
49 | - * |
|
50 | - * @since 18.0.0 |
|
51 | - */ |
|
52 | - public function getDescription(): string; |
|
43 | + /** |
|
44 | + * returns a translated, descriptive text to be presented in the web interface. |
|
45 | + * |
|
46 | + * It should be short and precise. |
|
47 | + * |
|
48 | + * Example: "Tag based automatic deletion of files after a given time." (en) |
|
49 | + * |
|
50 | + * @since 18.0.0 |
|
51 | + */ |
|
52 | + public function getDescription(): string; |
|
53 | 53 | |
54 | - /** |
|
55 | - * returns the URL to the icon of the operator for display in the web interface. |
|
56 | - * |
|
57 | - * Usually, the implementation would utilize the `imagePath()` method of the |
|
58 | - * `\OCP\IURLGenerator` instance and simply return its result. |
|
59 | - * |
|
60 | - * Example implementation: return $this->urlGenerator->imagePath('myApp', 'cat.svg'); |
|
61 | - * |
|
62 | - * @since 18.0.0 |
|
63 | - */ |
|
64 | - public function getIcon(): string; |
|
54 | + /** |
|
55 | + * returns the URL to the icon of the operator for display in the web interface. |
|
56 | + * |
|
57 | + * Usually, the implementation would utilize the `imagePath()` method of the |
|
58 | + * `\OCP\IURLGenerator` instance and simply return its result. |
|
59 | + * |
|
60 | + * Example implementation: return $this->urlGenerator->imagePath('myApp', 'cat.svg'); |
|
61 | + * |
|
62 | + * @since 18.0.0 |
|
63 | + */ |
|
64 | + public function getIcon(): string; |
|
65 | 65 | |
66 | - /** |
|
67 | - * returns whether the operation can be used in the requested scope. |
|
68 | - * |
|
69 | - * Scope IDs are defined as constants in OCP\WorkflowEngine\IManager. At |
|
70 | - * time of writing these are SCOPE_ADMIN and SCOPE_USER. |
|
71 | - * |
|
72 | - * For possibly unknown future scopes the recommended behaviour is: if |
|
73 | - * user scope is permitted, the default behaviour should return `true`, |
|
74 | - * otherwise `false`. |
|
75 | - * |
|
76 | - * @param int $scope |
|
77 | - * @psalm-param IManager::SCOPE_* $scope |
|
78 | - * |
|
79 | - * @since 18.0.0 |
|
80 | - */ |
|
81 | - public function isAvailableForScope(int $scope): bool; |
|
66 | + /** |
|
67 | + * returns whether the operation can be used in the requested scope. |
|
68 | + * |
|
69 | + * Scope IDs are defined as constants in OCP\WorkflowEngine\IManager. At |
|
70 | + * time of writing these are SCOPE_ADMIN and SCOPE_USER. |
|
71 | + * |
|
72 | + * For possibly unknown future scopes the recommended behaviour is: if |
|
73 | + * user scope is permitted, the default behaviour should return `true`, |
|
74 | + * otherwise `false`. |
|
75 | + * |
|
76 | + * @param int $scope |
|
77 | + * @psalm-param IManager::SCOPE_* $scope |
|
78 | + * |
|
79 | + * @since 18.0.0 |
|
80 | + */ |
|
81 | + public function isAvailableForScope(int $scope): bool; |
|
82 | 82 | |
83 | - /** |
|
84 | - * Validates whether a configured workflow rule is valid. If it is not, |
|
85 | - * an `\UnexpectedValueException` is supposed to be thrown. |
|
86 | - * |
|
87 | - * @throws \UnexpectedValueException |
|
88 | - * @since 9.1 |
|
89 | - */ |
|
90 | - public function validateOperation(string $name, array $checks, string $operation): void; |
|
83 | + /** |
|
84 | + * Validates whether a configured workflow rule is valid. If it is not, |
|
85 | + * an `\UnexpectedValueException` is supposed to be thrown. |
|
86 | + * |
|
87 | + * @throws \UnexpectedValueException |
|
88 | + * @since 9.1 |
|
89 | + */ |
|
90 | + public function validateOperation(string $name, array $checks, string $operation): void; |
|
91 | 91 | |
92 | - /** |
|
93 | - * Is being called by the workflow engine when an event was triggered that |
|
94 | - * is configured for this operation. An evaluation whether the event |
|
95 | - * qualifies for this operation to run has still to be done by the |
|
96 | - * implementor by calling the RuleMatchers getMatchingOperations method |
|
97 | - * and evaluating the results. |
|
98 | - * |
|
99 | - * If the implementor is an IComplexOperation, this method will not be |
|
100 | - * called automatically. It can be used or left as no-op by the implementor. |
|
101 | - * |
|
102 | - * @since 18.0.0 |
|
103 | - */ |
|
104 | - public function onEvent(string $eventName, Event $event, IRuleMatcher $ruleMatcher): void; |
|
92 | + /** |
|
93 | + * Is being called by the workflow engine when an event was triggered that |
|
94 | + * is configured for this operation. An evaluation whether the event |
|
95 | + * qualifies for this operation to run has still to be done by the |
|
96 | + * implementor by calling the RuleMatchers getMatchingOperations method |
|
97 | + * and evaluating the results. |
|
98 | + * |
|
99 | + * If the implementor is an IComplexOperation, this method will not be |
|
100 | + * called automatically. It can be used or left as no-op by the implementor. |
|
101 | + * |
|
102 | + * @since 18.0.0 |
|
103 | + */ |
|
104 | + public function onEvent(string $eventName, Event $event, IRuleMatcher $ruleMatcher): void; |
|
105 | 105 | } |
@@ -31,26 +31,26 @@ |
||
31 | 31 | * @since 23.0.0 |
32 | 32 | */ |
33 | 33 | interface ITrustedDomainHelper { |
34 | - /** |
|
35 | - * Checks whether a given URL is considered as trusted from the list |
|
36 | - * of trusted domains in the server's config file. If no trusted domains |
|
37 | - * have been configured and the url is valid, returns true. |
|
38 | - * |
|
39 | - * @param string $url |
|
40 | - * @return bool |
|
41 | - * @since 23.0.0 |
|
42 | - */ |
|
43 | - public function isTrustedUrl(string $url): bool; |
|
34 | + /** |
|
35 | + * Checks whether a given URL is considered as trusted from the list |
|
36 | + * of trusted domains in the server's config file. If no trusted domains |
|
37 | + * have been configured and the url is valid, returns true. |
|
38 | + * |
|
39 | + * @param string $url |
|
40 | + * @return bool |
|
41 | + * @since 23.0.0 |
|
42 | + */ |
|
43 | + public function isTrustedUrl(string $url): bool; |
|
44 | 44 | |
45 | - /** |
|
46 | - * Checks whether a given domain is considered as trusted from the list |
|
47 | - * of trusted domains in the server's config file. If no trusted domains |
|
48 | - * have been configured, returns true. |
|
49 | - * This is used to prevent Host Header Poisoning. |
|
50 | - * |
|
51 | - * @param string $domainWithPort |
|
52 | - * @return bool |
|
53 | - * @since 23.0.0 |
|
54 | - */ |
|
55 | - public function isTrustedDomain(string $domainWithPort): bool; |
|
45 | + /** |
|
46 | + * Checks whether a given domain is considered as trusted from the list |
|
47 | + * of trusted domains in the server's config file. If no trusted domains |
|
48 | + * have been configured, returns true. |
|
49 | + * This is used to prevent Host Header Poisoning. |
|
50 | + * |
|
51 | + * @param string $domainWithPort |
|
52 | + * @return bool |
|
53 | + * @since 23.0.0 |
|
54 | + */ |
|
55 | + public function isTrustedDomain(string $domainWithPort): bool; |
|
56 | 56 | } |
@@ -27,30 +27,30 @@ |
||
27 | 27 | * @since 9.0.0 |
28 | 28 | */ |
29 | 29 | interface IPropagator { |
30 | - /** |
|
31 | - * Mark the beginning of a propagation batch |
|
32 | - * |
|
33 | - * Note that not all cache setups support propagation in which case this will be a noop |
|
34 | - * |
|
35 | - * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent |
|
36 | - * before the batch is committed. |
|
37 | - * |
|
38 | - * @since 9.1.0 |
|
39 | - */ |
|
40 | - public function beginBatch(); |
|
30 | + /** |
|
31 | + * Mark the beginning of a propagation batch |
|
32 | + * |
|
33 | + * Note that not all cache setups support propagation in which case this will be a noop |
|
34 | + * |
|
35 | + * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent |
|
36 | + * before the batch is committed. |
|
37 | + * |
|
38 | + * @since 9.1.0 |
|
39 | + */ |
|
40 | + public function beginBatch(); |
|
41 | 41 | |
42 | - /** |
|
43 | - * Commit the active propagation batch |
|
44 | - * |
|
45 | - * @since 9.1.0 |
|
46 | - */ |
|
47 | - public function commitBatch(); |
|
42 | + /** |
|
43 | + * Commit the active propagation batch |
|
44 | + * |
|
45 | + * @since 9.1.0 |
|
46 | + */ |
|
47 | + public function commitBatch(); |
|
48 | 48 | |
49 | - /** |
|
50 | - * @param string $internalPath |
|
51 | - * @param int $time |
|
52 | - * @param int $sizeDifference |
|
53 | - * @since 9.0.0 |
|
54 | - */ |
|
55 | - public function propagateChange($internalPath, $time, $sizeDifference = 0); |
|
49 | + /** |
|
50 | + * @param string $internalPath |
|
51 | + * @param int $time |
|
52 | + * @param int $sizeDifference |
|
53 | + * @since 9.0.0 |
|
54 | + */ |
|
55 | + public function propagateChange($internalPath, $time, $sizeDifference = 0); |
|
56 | 56 | } |