@@ -44,23 +44,23 @@ |
||
44 | 44 | * @since 8.0.0 |
45 | 45 | */ |
46 | 46 | interface IHasher { |
47 | - /** |
|
48 | - * Hashes a message using PHP's `password_hash` functionality. |
|
49 | - * Please note that the size of the returned string is not guaranteed |
|
50 | - * and can be up to 255 characters. |
|
51 | - * |
|
52 | - * @param string $message Message to generate hash from |
|
53 | - * @return string Hash of the message with appended version parameter |
|
54 | - * @since 8.0.0 |
|
55 | - */ |
|
56 | - public function hash($message); |
|
47 | + /** |
|
48 | + * Hashes a message using PHP's `password_hash` functionality. |
|
49 | + * Please note that the size of the returned string is not guaranteed |
|
50 | + * and can be up to 255 characters. |
|
51 | + * |
|
52 | + * @param string $message Message to generate hash from |
|
53 | + * @return string Hash of the message with appended version parameter |
|
54 | + * @since 8.0.0 |
|
55 | + */ |
|
56 | + public function hash($message); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @param string $message Message to verify |
|
60 | - * @param string $hash Assumed hash of the message |
|
61 | - * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
62 | - * @return bool Whether $hash is a valid hash of $message |
|
63 | - * @since 8.0.0 |
|
64 | - */ |
|
65 | - public function verify($message, $hash, &$newHash = null); |
|
58 | + /** |
|
59 | + * @param string $message Message to verify |
|
60 | + * @param string $hash Assumed hash of the message |
|
61 | + * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
62 | + * @return bool Whether $hash is a valid hash of $message |
|
63 | + * @since 8.0.0 |
|
64 | + */ |
|
65 | + public function verify($message, $hash, &$newHash = null); |
|
66 | 66 | } |
@@ -30,22 +30,22 @@ |
||
30 | 30 | * @since 9.0.0 |
31 | 31 | */ |
32 | 32 | interface IContentSecurityPolicyManager { |
33 | - /** |
|
34 | - * Allows to inject something into the default content policy. This is for |
|
35 | - * example useful when you're injecting Javascript code into a view belonging |
|
36 | - * to another controller and cannot modify its Content-Security-Policy itself. |
|
37 | - * Note that the adjustment is only applied to applications that use AppFramework |
|
38 | - * controllers. |
|
39 | - * |
|
40 | - * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`, |
|
41 | - * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`. |
|
42 | - * |
|
43 | - * WARNING: Using this API incorrectly may make the instance more insecure. |
|
44 | - * Do think twice before adding whitelisting resources. Please do also note |
|
45 | - * that it is not possible to use the `disallowXYZ` functions. |
|
46 | - * |
|
47 | - * @param EmptyContentSecurityPolicy $policy |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function addDefaultPolicy(EmptyContentSecurityPolicy $policy); |
|
33 | + /** |
|
34 | + * Allows to inject something into the default content policy. This is for |
|
35 | + * example useful when you're injecting Javascript code into a view belonging |
|
36 | + * to another controller and cannot modify its Content-Security-Policy itself. |
|
37 | + * Note that the adjustment is only applied to applications that use AppFramework |
|
38 | + * controllers. |
|
39 | + * |
|
40 | + * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`, |
|
41 | + * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`. |
|
42 | + * |
|
43 | + * WARNING: Using this API incorrectly may make the instance more insecure. |
|
44 | + * Do think twice before adding whitelisting resources. Please do also note |
|
45 | + * that it is not possible to use the `disallowXYZ` functions. |
|
46 | + * |
|
47 | + * @param EmptyContentSecurityPolicy $policy |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function addDefaultPolicy(EmptyContentSecurityPolicy $policy); |
|
51 | 51 | } |
@@ -36,30 +36,30 @@ |
||
36 | 36 | */ |
37 | 37 | interface ICrypto { |
38 | 38 | |
39 | - /** |
|
40 | - * @param string $message The message to authenticate |
|
41 | - * @param string $password Password to use (defaults to `secret` in config.php) |
|
42 | - * @return string Calculated HMAC |
|
43 | - * @since 8.0.0 |
|
44 | - */ |
|
45 | - public function calculateHMAC($message, $password = ''); |
|
39 | + /** |
|
40 | + * @param string $message The message to authenticate |
|
41 | + * @param string $password Password to use (defaults to `secret` in config.php) |
|
42 | + * @return string Calculated HMAC |
|
43 | + * @since 8.0.0 |
|
44 | + */ |
|
45 | + public function calculateHMAC($message, $password = ''); |
|
46 | 46 | |
47 | - /** |
|
48 | - * Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
49 | - * @param string $plaintext |
|
50 | - * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
51 | - * @return string Authenticated ciphertext |
|
52 | - * @since 8.0.0 |
|
53 | - */ |
|
54 | - public function encrypt($plaintext, $password = ''); |
|
47 | + /** |
|
48 | + * Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
49 | + * @param string $plaintext |
|
50 | + * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
51 | + * @return string Authenticated ciphertext |
|
52 | + * @since 8.0.0 |
|
53 | + */ |
|
54 | + public function encrypt($plaintext, $password = ''); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
58 | - * @param string $authenticatedCiphertext |
|
59 | - * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
60 | - * @return string plaintext |
|
61 | - * @throws \Exception If the HMAC does not match |
|
62 | - * @since 8.0.0 |
|
63 | - */ |
|
64 | - public function decrypt($authenticatedCiphertext, $password = ''); |
|
56 | + /** |
|
57 | + * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
58 | + * @param string $authenticatedCiphertext |
|
59 | + * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
60 | + * @return string plaintext |
|
61 | + * @throws \Exception If the HMAC does not match |
|
62 | + * @since 8.0.0 |
|
63 | + */ |
|
64 | + public function decrypt($authenticatedCiphertext, $password = ''); |
|
65 | 65 | } |
@@ -26,35 +26,35 @@ |
||
26 | 26 | * @since 12.0.0 |
27 | 27 | */ |
28 | 28 | interface ICloudId { |
29 | - /** |
|
30 | - * The remote cloud id |
|
31 | - * |
|
32 | - * @return string |
|
33 | - * @since 12.0.0 |
|
34 | - */ |
|
35 | - public function getId(); |
|
29 | + /** |
|
30 | + * The remote cloud id |
|
31 | + * |
|
32 | + * @return string |
|
33 | + * @since 12.0.0 |
|
34 | + */ |
|
35 | + public function getId(); |
|
36 | 36 | |
37 | - /** |
|
38 | - * Get a clean representation of the cloud id for display |
|
39 | - * |
|
40 | - * @return string |
|
41 | - * @since 12.0.0 |
|
42 | - */ |
|
43 | - public function getDisplayId(); |
|
37 | + /** |
|
38 | + * Get a clean representation of the cloud id for display |
|
39 | + * |
|
40 | + * @return string |
|
41 | + * @since 12.0.0 |
|
42 | + */ |
|
43 | + public function getDisplayId(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * The username on the remote server |
|
47 | - * |
|
48 | - * @return string |
|
49 | - * @since 12.0.0 |
|
50 | - */ |
|
51 | - public function getUser(); |
|
45 | + /** |
|
46 | + * The username on the remote server |
|
47 | + * |
|
48 | + * @return string |
|
49 | + * @since 12.0.0 |
|
50 | + */ |
|
51 | + public function getUser(); |
|
52 | 52 | |
53 | - /** |
|
54 | - * The base address of the remote server |
|
55 | - * |
|
56 | - * @return string |
|
57 | - * @since 12.0.0 |
|
58 | - */ |
|
59 | - public function getRemote(); |
|
53 | + /** |
|
54 | + * The base address of the remote server |
|
55 | + * |
|
56 | + * @return string |
|
57 | + * @since 12.0.0 |
|
58 | + */ |
|
59 | + public function getRemote(); |
|
60 | 60 | } |
@@ -26,32 +26,32 @@ |
||
26 | 26 | * @since 12.0.0 |
27 | 27 | */ |
28 | 28 | interface ICloudIdManager { |
29 | - /** |
|
30 | - * @param string $cloudId |
|
31 | - * @return ICloudId |
|
32 | - * |
|
33 | - * @since 12.0.0 |
|
34 | - */ |
|
35 | - public function resolveCloudId($cloudId); |
|
29 | + /** |
|
30 | + * @param string $cloudId |
|
31 | + * @return ICloudId |
|
32 | + * |
|
33 | + * @since 12.0.0 |
|
34 | + */ |
|
35 | + public function resolveCloudId($cloudId); |
|
36 | 36 | |
37 | - /** |
|
38 | - * Get the cloud id for a remote user |
|
39 | - * |
|
40 | - * @param string $user |
|
41 | - * @param string $remote |
|
42 | - * @return ICloudId |
|
43 | - * |
|
44 | - * @since 12.0.0 |
|
45 | - */ |
|
46 | - public function getCloudId($user, $remote); |
|
37 | + /** |
|
38 | + * Get the cloud id for a remote user |
|
39 | + * |
|
40 | + * @param string $user |
|
41 | + * @param string $remote |
|
42 | + * @return ICloudId |
|
43 | + * |
|
44 | + * @since 12.0.0 |
|
45 | + */ |
|
46 | + public function getCloudId($user, $remote); |
|
47 | 47 | |
48 | - /** |
|
49 | - * Check if the input is a correctly formatted cloud id |
|
50 | - * |
|
51 | - * @param string $cloudId |
|
52 | - * @return bool |
|
53 | - * |
|
54 | - * @since 12.0.0 |
|
55 | - */ |
|
56 | - public function isValidCloudId($cloudId); |
|
48 | + /** |
|
49 | + * Check if the input is a correctly formatted cloud id |
|
50 | + * |
|
51 | + * @param string $cloudId |
|
52 | + * @return bool |
|
53 | + * |
|
54 | + * @since 12.0.0 |
|
55 | + */ |
|
56 | + public function isValidCloudId($cloudId); |
|
57 | 57 | } |
@@ -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 |
@@ -41,145 +41,145 @@ |
||
41 | 41 | * @since 8.0.0 |
42 | 42 | */ |
43 | 43 | interface IUserManager { |
44 | - /** |
|
45 | - * register a user backend |
|
46 | - * |
|
47 | - * @param \OCP\UserInterface $backend |
|
48 | - * @since 8.0.0 |
|
49 | - */ |
|
50 | - public function registerBackend($backend); |
|
51 | - |
|
52 | - /** |
|
53 | - * Get the active backends |
|
54 | - * @return \OCP\UserInterface[] |
|
55 | - * @since 8.0.0 |
|
56 | - */ |
|
57 | - public function getBackends(); |
|
58 | - |
|
59 | - /** |
|
60 | - * remove a user backend |
|
61 | - * |
|
62 | - * @param \OCP\UserInterface $backend |
|
63 | - * @since 8.0.0 |
|
64 | - */ |
|
65 | - public function removeBackend($backend); |
|
66 | - |
|
67 | - /** |
|
68 | - * remove all user backends |
|
69 | - * @since 8.0.0 |
|
70 | - */ |
|
71 | - public function clearBackends() ; |
|
72 | - |
|
73 | - /** |
|
74 | - * get a user by user id |
|
75 | - * |
|
76 | - * @param string $uid |
|
77 | - * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
78 | - * @since 8.0.0 |
|
79 | - */ |
|
80 | - public function get($uid); |
|
81 | - |
|
82 | - /** |
|
83 | - * check if a user exists |
|
84 | - * |
|
85 | - * @param string $uid |
|
86 | - * @return bool |
|
87 | - * @since 8.0.0 |
|
88 | - */ |
|
89 | - public function userExists($uid); |
|
90 | - |
|
91 | - /** |
|
92 | - * Check if the password is valid for the user |
|
93 | - * |
|
94 | - * @param string $loginName |
|
95 | - * @param string $password |
|
96 | - * @return mixed the User object on success, false otherwise |
|
97 | - * @since 8.0.0 |
|
98 | - */ |
|
99 | - public function checkPassword($loginName, $password); |
|
100 | - |
|
101 | - /** |
|
102 | - * search by user id |
|
103 | - * |
|
104 | - * @param string $pattern |
|
105 | - * @param int $limit |
|
106 | - * @param int $offset |
|
107 | - * @return \OCP\IUser[] |
|
108 | - * @since 8.0.0 |
|
109 | - */ |
|
110 | - public function search($pattern, $limit = null, $offset = null); |
|
111 | - |
|
112 | - /** |
|
113 | - * search by displayName |
|
114 | - * |
|
115 | - * @param string $pattern |
|
116 | - * @param int $limit |
|
117 | - * @param int $offset |
|
118 | - * @return \OCP\IUser[] |
|
119 | - * @since 8.0.0 |
|
120 | - */ |
|
121 | - public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
122 | - |
|
123 | - /** |
|
124 | - * @param string $uid |
|
125 | - * @param string $password |
|
126 | - * @throws \InvalidArgumentException |
|
127 | - * @return bool|\OCP\IUser the created user of false |
|
128 | - * @since 8.0.0 |
|
129 | - */ |
|
130 | - public function createUser($uid, $password); |
|
131 | - |
|
132 | - /** |
|
133 | - * @param string $uid |
|
134 | - * @param string $password |
|
135 | - * @param UserInterface $backend |
|
136 | - * @return IUser|null |
|
137 | - * @throws \InvalidArgumentException |
|
138 | - * @since 12.0.0 |
|
139 | - */ |
|
140 | - public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
141 | - |
|
142 | - /** |
|
143 | - * returns how many users per backend exist (if supported by backend) |
|
144 | - * |
|
145 | - * @return array an array of backend class as key and count number as value |
|
146 | - * @since 8.0.0 |
|
147 | - */ |
|
148 | - public function countUsers(); |
|
149 | - |
|
150 | - /** |
|
151 | - * @param \Closure $callback |
|
152 | - * @param string $search |
|
153 | - * @since 9.0.0 |
|
154 | - */ |
|
155 | - public function callForAllUsers(\Closure $callback, $search = ''); |
|
156 | - |
|
157 | - /** |
|
158 | - * returns how many users have logged in once |
|
159 | - * |
|
160 | - * @return int |
|
161 | - * @since 11.0.0 |
|
162 | - */ |
|
163 | - public function countDisabledUsers(); |
|
164 | - |
|
165 | - /** |
|
166 | - * returns how many users have logged in once |
|
167 | - * |
|
168 | - * @return int |
|
169 | - * @since 11.0.0 |
|
170 | - */ |
|
171 | - public function countSeenUsers(); |
|
172 | - |
|
173 | - /** |
|
174 | - * @param \Closure $callback |
|
175 | - * @since 11.0.0 |
|
176 | - */ |
|
177 | - public function callForSeenUsers(\Closure $callback); |
|
178 | - |
|
179 | - /** |
|
180 | - * @param string $email |
|
181 | - * @return IUser[] |
|
182 | - * @since 9.1.0 |
|
183 | - */ |
|
184 | - public function getByEmail($email); |
|
44 | + /** |
|
45 | + * register a user backend |
|
46 | + * |
|
47 | + * @param \OCP\UserInterface $backend |
|
48 | + * @since 8.0.0 |
|
49 | + */ |
|
50 | + public function registerBackend($backend); |
|
51 | + |
|
52 | + /** |
|
53 | + * Get the active backends |
|
54 | + * @return \OCP\UserInterface[] |
|
55 | + * @since 8.0.0 |
|
56 | + */ |
|
57 | + public function getBackends(); |
|
58 | + |
|
59 | + /** |
|
60 | + * remove a user backend |
|
61 | + * |
|
62 | + * @param \OCP\UserInterface $backend |
|
63 | + * @since 8.0.0 |
|
64 | + */ |
|
65 | + public function removeBackend($backend); |
|
66 | + |
|
67 | + /** |
|
68 | + * remove all user backends |
|
69 | + * @since 8.0.0 |
|
70 | + */ |
|
71 | + public function clearBackends() ; |
|
72 | + |
|
73 | + /** |
|
74 | + * get a user by user id |
|
75 | + * |
|
76 | + * @param string $uid |
|
77 | + * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
78 | + * @since 8.0.0 |
|
79 | + */ |
|
80 | + public function get($uid); |
|
81 | + |
|
82 | + /** |
|
83 | + * check if a user exists |
|
84 | + * |
|
85 | + * @param string $uid |
|
86 | + * @return bool |
|
87 | + * @since 8.0.0 |
|
88 | + */ |
|
89 | + public function userExists($uid); |
|
90 | + |
|
91 | + /** |
|
92 | + * Check if the password is valid for the user |
|
93 | + * |
|
94 | + * @param string $loginName |
|
95 | + * @param string $password |
|
96 | + * @return mixed the User object on success, false otherwise |
|
97 | + * @since 8.0.0 |
|
98 | + */ |
|
99 | + public function checkPassword($loginName, $password); |
|
100 | + |
|
101 | + /** |
|
102 | + * search by user id |
|
103 | + * |
|
104 | + * @param string $pattern |
|
105 | + * @param int $limit |
|
106 | + * @param int $offset |
|
107 | + * @return \OCP\IUser[] |
|
108 | + * @since 8.0.0 |
|
109 | + */ |
|
110 | + public function search($pattern, $limit = null, $offset = null); |
|
111 | + |
|
112 | + /** |
|
113 | + * search by displayName |
|
114 | + * |
|
115 | + * @param string $pattern |
|
116 | + * @param int $limit |
|
117 | + * @param int $offset |
|
118 | + * @return \OCP\IUser[] |
|
119 | + * @since 8.0.0 |
|
120 | + */ |
|
121 | + public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
122 | + |
|
123 | + /** |
|
124 | + * @param string $uid |
|
125 | + * @param string $password |
|
126 | + * @throws \InvalidArgumentException |
|
127 | + * @return bool|\OCP\IUser the created user of false |
|
128 | + * @since 8.0.0 |
|
129 | + */ |
|
130 | + public function createUser($uid, $password); |
|
131 | + |
|
132 | + /** |
|
133 | + * @param string $uid |
|
134 | + * @param string $password |
|
135 | + * @param UserInterface $backend |
|
136 | + * @return IUser|null |
|
137 | + * @throws \InvalidArgumentException |
|
138 | + * @since 12.0.0 |
|
139 | + */ |
|
140 | + public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
141 | + |
|
142 | + /** |
|
143 | + * returns how many users per backend exist (if supported by backend) |
|
144 | + * |
|
145 | + * @return array an array of backend class as key and count number as value |
|
146 | + * @since 8.0.0 |
|
147 | + */ |
|
148 | + public function countUsers(); |
|
149 | + |
|
150 | + /** |
|
151 | + * @param \Closure $callback |
|
152 | + * @param string $search |
|
153 | + * @since 9.0.0 |
|
154 | + */ |
|
155 | + public function callForAllUsers(\Closure $callback, $search = ''); |
|
156 | + |
|
157 | + /** |
|
158 | + * returns how many users have logged in once |
|
159 | + * |
|
160 | + * @return int |
|
161 | + * @since 11.0.0 |
|
162 | + */ |
|
163 | + public function countDisabledUsers(); |
|
164 | + |
|
165 | + /** |
|
166 | + * returns how many users have logged in once |
|
167 | + * |
|
168 | + * @return int |
|
169 | + * @since 11.0.0 |
|
170 | + */ |
|
171 | + public function countSeenUsers(); |
|
172 | + |
|
173 | + /** |
|
174 | + * @param \Closure $callback |
|
175 | + * @since 11.0.0 |
|
176 | + */ |
|
177 | + public function callForSeenUsers(\Closure $callback); |
|
178 | + |
|
179 | + /** |
|
180 | + * @param string $email |
|
181 | + * @return IUser[] |
|
182 | + * @since 9.1.0 |
|
183 | + */ |
|
184 | + public function getByEmail($email); |
|
185 | 185 | } |
@@ -31,28 +31,28 @@ |
||
31 | 31 | * @since 8.1.0 |
32 | 32 | */ |
33 | 33 | interface IResponse { |
34 | - /** |
|
35 | - * @return string|resource |
|
36 | - * @since 8.1.0 |
|
37 | - */ |
|
38 | - public function getBody(); |
|
34 | + /** |
|
35 | + * @return string|resource |
|
36 | + * @since 8.1.0 |
|
37 | + */ |
|
38 | + public function getBody(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return int |
|
42 | - * @since 8.1.0 |
|
43 | - */ |
|
44 | - public function getStatusCode(); |
|
40 | + /** |
|
41 | + * @return int |
|
42 | + * @since 8.1.0 |
|
43 | + */ |
|
44 | + public function getStatusCode(); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @param $key |
|
48 | - * @return string |
|
49 | - * @since 8.1.0 |
|
50 | - */ |
|
51 | - public function getHeader($key); |
|
46 | + /** |
|
47 | + * @param $key |
|
48 | + * @return string |
|
49 | + * @since 8.1.0 |
|
50 | + */ |
|
51 | + public function getHeader($key); |
|
52 | 52 | |
53 | - /** |
|
54 | - * @return array |
|
55 | - * @since 8.1.0 |
|
56 | - */ |
|
57 | - public function getHeaders(); |
|
53 | + /** |
|
54 | + * @return array |
|
55 | + * @since 8.1.0 |
|
56 | + */ |
|
57 | + public function getHeaders(); |
|
58 | 58 | } |
@@ -31,178 +31,178 @@ |
||
31 | 31 | */ |
32 | 32 | interface IClient { |
33 | 33 | |
34 | - /** |
|
35 | - * Sends a GET request |
|
36 | - * @param string $uri |
|
37 | - * @param array $options Array such as |
|
38 | - * 'query' => [ |
|
39 | - * 'field' => 'abc', |
|
40 | - * 'other_field' => '123', |
|
41 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
42 | - * ], |
|
43 | - * 'headers' => [ |
|
44 | - * 'foo' => 'bar', |
|
45 | - * ], |
|
46 | - * 'cookies' => [' |
|
47 | - * 'foo' => 'bar', |
|
48 | - * ], |
|
49 | - * 'allow_redirects' => [ |
|
50 | - * 'max' => 10, // allow at most 10 redirects. |
|
51 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
52 | - * 'referer' => true, // add a Referer header |
|
53 | - * 'protocols' => ['https'] // only allow https URLs |
|
54 | - * ], |
|
55 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
56 | - * 'verify' => true, // bool or string to CA file |
|
57 | - * 'debug' => true, |
|
58 | - * @return IResponse |
|
59 | - * @throws \Exception If the request could not get completed |
|
60 | - * @since 8.1.0 |
|
61 | - */ |
|
62 | - public function get($uri, array $options = []); |
|
34 | + /** |
|
35 | + * Sends a GET request |
|
36 | + * @param string $uri |
|
37 | + * @param array $options Array such as |
|
38 | + * 'query' => [ |
|
39 | + * 'field' => 'abc', |
|
40 | + * 'other_field' => '123', |
|
41 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
42 | + * ], |
|
43 | + * 'headers' => [ |
|
44 | + * 'foo' => 'bar', |
|
45 | + * ], |
|
46 | + * 'cookies' => [' |
|
47 | + * 'foo' => 'bar', |
|
48 | + * ], |
|
49 | + * 'allow_redirects' => [ |
|
50 | + * 'max' => 10, // allow at most 10 redirects. |
|
51 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
52 | + * 'referer' => true, // add a Referer header |
|
53 | + * 'protocols' => ['https'] // only allow https URLs |
|
54 | + * ], |
|
55 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
56 | + * 'verify' => true, // bool or string to CA file |
|
57 | + * 'debug' => true, |
|
58 | + * @return IResponse |
|
59 | + * @throws \Exception If the request could not get completed |
|
60 | + * @since 8.1.0 |
|
61 | + */ |
|
62 | + public function get($uri, array $options = []); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Sends a HEAD request |
|
66 | - * @param string $uri |
|
67 | - * @param array $options Array such as |
|
68 | - * 'headers' => [ |
|
69 | - * 'foo' => 'bar', |
|
70 | - * ], |
|
71 | - * 'cookies' => [' |
|
72 | - * 'foo' => 'bar', |
|
73 | - * ], |
|
74 | - * 'allow_redirects' => [ |
|
75 | - * 'max' => 10, // allow at most 10 redirects. |
|
76 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
77 | - * 'referer' => true, // add a Referer header |
|
78 | - * 'protocols' => ['https'] // only allow https URLs |
|
79 | - * ], |
|
80 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
81 | - * 'verify' => true, // bool or string to CA file |
|
82 | - * 'debug' => true, |
|
83 | - * @return IResponse |
|
84 | - * @throws \Exception If the request could not get completed |
|
85 | - * @since 8.1.0 |
|
86 | - */ |
|
87 | - public function head($uri, $options = []); |
|
64 | + /** |
|
65 | + * Sends a HEAD request |
|
66 | + * @param string $uri |
|
67 | + * @param array $options Array such as |
|
68 | + * 'headers' => [ |
|
69 | + * 'foo' => 'bar', |
|
70 | + * ], |
|
71 | + * 'cookies' => [' |
|
72 | + * 'foo' => 'bar', |
|
73 | + * ], |
|
74 | + * 'allow_redirects' => [ |
|
75 | + * 'max' => 10, // allow at most 10 redirects. |
|
76 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
77 | + * 'referer' => true, // add a Referer header |
|
78 | + * 'protocols' => ['https'] // only allow https URLs |
|
79 | + * ], |
|
80 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
81 | + * 'verify' => true, // bool or string to CA file |
|
82 | + * 'debug' => true, |
|
83 | + * @return IResponse |
|
84 | + * @throws \Exception If the request could not get completed |
|
85 | + * @since 8.1.0 |
|
86 | + */ |
|
87 | + public function head($uri, $options = []); |
|
88 | 88 | |
89 | - /** |
|
90 | - * Sends a POST request |
|
91 | - * @param string $uri |
|
92 | - * @param array $options Array such as |
|
93 | - * 'body' => [ |
|
94 | - * 'field' => 'abc', |
|
95 | - * 'other_field' => '123', |
|
96 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
97 | - * ], |
|
98 | - * 'headers' => [ |
|
99 | - * 'foo' => 'bar', |
|
100 | - * ], |
|
101 | - * 'cookies' => [' |
|
102 | - * 'foo' => 'bar', |
|
103 | - * ], |
|
104 | - * 'allow_redirects' => [ |
|
105 | - * 'max' => 10, // allow at most 10 redirects. |
|
106 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
107 | - * 'referer' => true, // add a Referer header |
|
108 | - * 'protocols' => ['https'] // only allow https URLs |
|
109 | - * ], |
|
110 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
111 | - * 'verify' => true, // bool or string to CA file |
|
112 | - * 'debug' => true, |
|
113 | - * @return IResponse |
|
114 | - * @throws \Exception If the request could not get completed |
|
115 | - * @since 8.1.0 |
|
116 | - */ |
|
117 | - public function post($uri, array $options = []); |
|
89 | + /** |
|
90 | + * Sends a POST request |
|
91 | + * @param string $uri |
|
92 | + * @param array $options Array such as |
|
93 | + * 'body' => [ |
|
94 | + * 'field' => 'abc', |
|
95 | + * 'other_field' => '123', |
|
96 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
97 | + * ], |
|
98 | + * 'headers' => [ |
|
99 | + * 'foo' => 'bar', |
|
100 | + * ], |
|
101 | + * 'cookies' => [' |
|
102 | + * 'foo' => 'bar', |
|
103 | + * ], |
|
104 | + * 'allow_redirects' => [ |
|
105 | + * 'max' => 10, // allow at most 10 redirects. |
|
106 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
107 | + * 'referer' => true, // add a Referer header |
|
108 | + * 'protocols' => ['https'] // only allow https URLs |
|
109 | + * ], |
|
110 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
111 | + * 'verify' => true, // bool or string to CA file |
|
112 | + * 'debug' => true, |
|
113 | + * @return IResponse |
|
114 | + * @throws \Exception If the request could not get completed |
|
115 | + * @since 8.1.0 |
|
116 | + */ |
|
117 | + public function post($uri, array $options = []); |
|
118 | 118 | |
119 | - /** |
|
120 | - * Sends a PUT request |
|
121 | - * @param string $uri |
|
122 | - * @param array $options Array such as |
|
123 | - * 'body' => [ |
|
124 | - * 'field' => 'abc', |
|
125 | - * 'other_field' => '123', |
|
126 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
127 | - * ], |
|
128 | - * 'headers' => [ |
|
129 | - * 'foo' => 'bar', |
|
130 | - * ], |
|
131 | - * 'cookies' => [' |
|
132 | - * 'foo' => 'bar', |
|
133 | - * ], |
|
134 | - * 'allow_redirects' => [ |
|
135 | - * 'max' => 10, // allow at most 10 redirects. |
|
136 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
137 | - * 'referer' => true, // add a Referer header |
|
138 | - * 'protocols' => ['https'] // only allow https URLs |
|
139 | - * ], |
|
140 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
141 | - * 'verify' => true, // bool or string to CA file |
|
142 | - * 'debug' => true, |
|
143 | - * @return IResponse |
|
144 | - * @throws \Exception If the request could not get completed |
|
145 | - * @since 8.1.0 |
|
146 | - */ |
|
147 | - public function put($uri, array $options = []); |
|
119 | + /** |
|
120 | + * Sends a PUT request |
|
121 | + * @param string $uri |
|
122 | + * @param array $options Array such as |
|
123 | + * 'body' => [ |
|
124 | + * 'field' => 'abc', |
|
125 | + * 'other_field' => '123', |
|
126 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
127 | + * ], |
|
128 | + * 'headers' => [ |
|
129 | + * 'foo' => 'bar', |
|
130 | + * ], |
|
131 | + * 'cookies' => [' |
|
132 | + * 'foo' => 'bar', |
|
133 | + * ], |
|
134 | + * 'allow_redirects' => [ |
|
135 | + * 'max' => 10, // allow at most 10 redirects. |
|
136 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
137 | + * 'referer' => true, // add a Referer header |
|
138 | + * 'protocols' => ['https'] // only allow https URLs |
|
139 | + * ], |
|
140 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
141 | + * 'verify' => true, // bool or string to CA file |
|
142 | + * 'debug' => true, |
|
143 | + * @return IResponse |
|
144 | + * @throws \Exception If the request could not get completed |
|
145 | + * @since 8.1.0 |
|
146 | + */ |
|
147 | + public function put($uri, array $options = []); |
|
148 | 148 | |
149 | - /** |
|
150 | - * Sends a DELETE request |
|
151 | - * @param string $uri |
|
152 | - * @param array $options Array such as |
|
153 | - * 'body' => [ |
|
154 | - * 'field' => 'abc', |
|
155 | - * 'other_field' => '123', |
|
156 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
157 | - * ], |
|
158 | - * 'headers' => [ |
|
159 | - * 'foo' => 'bar', |
|
160 | - * ], |
|
161 | - * 'cookies' => [' |
|
162 | - * 'foo' => 'bar', |
|
163 | - * ], |
|
164 | - * 'allow_redirects' => [ |
|
165 | - * 'max' => 10, // allow at most 10 redirects. |
|
166 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
167 | - * 'referer' => true, // add a Referer header |
|
168 | - * 'protocols' => ['https'] // only allow https URLs |
|
169 | - * ], |
|
170 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
171 | - * 'verify' => true, // bool or string to CA file |
|
172 | - * 'debug' => true, |
|
173 | - * @return IResponse |
|
174 | - * @throws \Exception If the request could not get completed |
|
175 | - * @since 8.1.0 |
|
176 | - */ |
|
177 | - public function delete($uri, array $options = []); |
|
149 | + /** |
|
150 | + * Sends a DELETE request |
|
151 | + * @param string $uri |
|
152 | + * @param array $options Array such as |
|
153 | + * 'body' => [ |
|
154 | + * 'field' => 'abc', |
|
155 | + * 'other_field' => '123', |
|
156 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
157 | + * ], |
|
158 | + * 'headers' => [ |
|
159 | + * 'foo' => 'bar', |
|
160 | + * ], |
|
161 | + * 'cookies' => [' |
|
162 | + * 'foo' => 'bar', |
|
163 | + * ], |
|
164 | + * 'allow_redirects' => [ |
|
165 | + * 'max' => 10, // allow at most 10 redirects. |
|
166 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
167 | + * 'referer' => true, // add a Referer header |
|
168 | + * 'protocols' => ['https'] // only allow https URLs |
|
169 | + * ], |
|
170 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
171 | + * 'verify' => true, // bool or string to CA file |
|
172 | + * 'debug' => true, |
|
173 | + * @return IResponse |
|
174 | + * @throws \Exception If the request could not get completed |
|
175 | + * @since 8.1.0 |
|
176 | + */ |
|
177 | + public function delete($uri, array $options = []); |
|
178 | 178 | |
179 | - /** |
|
180 | - * Sends a options request |
|
181 | - * @param string $uri |
|
182 | - * @param array $options Array such as |
|
183 | - * 'body' => [ |
|
184 | - * 'field' => 'abc', |
|
185 | - * 'other_field' => '123', |
|
186 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
187 | - * ], |
|
188 | - * 'headers' => [ |
|
189 | - * 'foo' => 'bar', |
|
190 | - * ], |
|
191 | - * 'cookies' => [' |
|
192 | - * 'foo' => 'bar', |
|
193 | - * ], |
|
194 | - * 'allow_redirects' => [ |
|
195 | - * 'max' => 10, // allow at most 10 redirects. |
|
196 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
197 | - * 'referer' => true, // add a Referer header |
|
198 | - * 'protocols' => ['https'] // only allow https URLs |
|
199 | - * ], |
|
200 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
201 | - * 'verify' => true, // bool or string to CA file |
|
202 | - * 'debug' => true, |
|
203 | - * @return IResponse |
|
204 | - * @throws \Exception If the request could not get completed |
|
205 | - * @since 8.1.0 |
|
206 | - */ |
|
207 | - public function options($uri, array $options = []); |
|
179 | + /** |
|
180 | + * Sends a options request |
|
181 | + * @param string $uri |
|
182 | + * @param array $options Array such as |
|
183 | + * 'body' => [ |
|
184 | + * 'field' => 'abc', |
|
185 | + * 'other_field' => '123', |
|
186 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
187 | + * ], |
|
188 | + * 'headers' => [ |
|
189 | + * 'foo' => 'bar', |
|
190 | + * ], |
|
191 | + * 'cookies' => [' |
|
192 | + * 'foo' => 'bar', |
|
193 | + * ], |
|
194 | + * 'allow_redirects' => [ |
|
195 | + * 'max' => 10, // allow at most 10 redirects. |
|
196 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
197 | + * 'referer' => true, // add a Referer header |
|
198 | + * 'protocols' => ['https'] // only allow https URLs |
|
199 | + * ], |
|
200 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
201 | + * 'verify' => true, // bool or string to CA file |
|
202 | + * 'debug' => true, |
|
203 | + * @return IResponse |
|
204 | + * @throws \Exception If the request could not get completed |
|
205 | + * @since 8.1.0 |
|
206 | + */ |
|
207 | + public function options($uri, array $options = []); |
|
208 | 208 | } |
@@ -30,9 +30,9 @@ |
||
30 | 30 | * @since 8.1.0 |
31 | 31 | */ |
32 | 32 | interface IClientService { |
33 | - /** |
|
34 | - * @return IClient |
|
35 | - * @since 8.1.0 |
|
36 | - */ |
|
37 | - public function newClient(); |
|
33 | + /** |
|
34 | + * @return IClient |
|
35 | + * @since 8.1.0 |
|
36 | + */ |
|
37 | + public function newClient(); |
|
38 | 38 | } |