@@ -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 | } |
@@ -31,18 +31,18 @@ |
||
| 31 | 31 | * @since 8.0.0 |
| 32 | 32 | */ |
| 33 | 33 | class StringUtils { |
| 34 | - /** |
|
| 35 | - * Compares whether two strings are equal. To prevent guessing of the string |
|
| 36 | - * length this is done by comparing two hashes against each other and afterwards |
|
| 37 | - * a comparison of the real string to prevent against the unlikely chance of |
|
| 38 | - * collisions. |
|
| 39 | - * @param string $expected The expected value |
|
| 40 | - * @param string $input The input to compare against |
|
| 41 | - * @return bool True if the two strings are equal, otherwise false. |
|
| 42 | - * @since 8.0.0 |
|
| 43 | - * @deprecated 9.0.0 Use hash_equals |
|
| 44 | - */ |
|
| 45 | - public static function equals($expected, $input) { |
|
| 46 | - return hash_equals($expected, $input); |
|
| 47 | - } |
|
| 34 | + /** |
|
| 35 | + * Compares whether two strings are equal. To prevent guessing of the string |
|
| 36 | + * length this is done by comparing two hashes against each other and afterwards |
|
| 37 | + * a comparison of the real string to prevent against the unlikely chance of |
|
| 38 | + * collisions. |
|
| 39 | + * @param string $expected The expected value |
|
| 40 | + * @param string $input The input to compare against |
|
| 41 | + * @return bool True if the two strings are equal, otherwise false. |
|
| 42 | + * @since 8.0.0 |
|
| 43 | + * @deprecated 9.0.0 Use hash_equals |
|
| 44 | + */ |
|
| 45 | + public static function equals($expected, $input) { |
|
| 46 | + return hash_equals($expected, $input); |
|
| 47 | + } |
|
| 48 | 48 | } |
@@ -30,43 +30,43 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface ICredentialsManager { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Store a set of credentials |
|
| 35 | - * |
|
| 36 | - * @param string|null $userId Null for system-wide credentials |
|
| 37 | - * @param string $identifier |
|
| 38 | - * @param mixed $credentials |
|
| 39 | - * @since 8.2.0 |
|
| 40 | - */ |
|
| 41 | - public function store($userId, $identifier, $credentials); |
|
| 33 | + /** |
|
| 34 | + * Store a set of credentials |
|
| 35 | + * |
|
| 36 | + * @param string|null $userId Null for system-wide credentials |
|
| 37 | + * @param string $identifier |
|
| 38 | + * @param mixed $credentials |
|
| 39 | + * @since 8.2.0 |
|
| 40 | + */ |
|
| 41 | + public function store($userId, $identifier, $credentials); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Retrieve a set of credentials |
|
| 45 | - * |
|
| 46 | - * @param string|null $userId Null for system-wide credentials |
|
| 47 | - * @param string $identifier |
|
| 48 | - * @return mixed |
|
| 49 | - * @since 8.2.0 |
|
| 50 | - */ |
|
| 51 | - public function retrieve($userId, $identifier); |
|
| 43 | + /** |
|
| 44 | + * Retrieve a set of credentials |
|
| 45 | + * |
|
| 46 | + * @param string|null $userId Null for system-wide credentials |
|
| 47 | + * @param string $identifier |
|
| 48 | + * @return mixed |
|
| 49 | + * @since 8.2.0 |
|
| 50 | + */ |
|
| 51 | + public function retrieve($userId, $identifier); |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Delete a set of credentials |
|
| 55 | - * |
|
| 56 | - * @param string|null $userId Null for system-wide credentials |
|
| 57 | - * @param string $identifier |
|
| 58 | - * @return int rows removed |
|
| 59 | - * @since 8.2.0 |
|
| 60 | - */ |
|
| 61 | - public function delete($userId, $identifier); |
|
| 53 | + /** |
|
| 54 | + * Delete a set of credentials |
|
| 55 | + * |
|
| 56 | + * @param string|null $userId Null for system-wide credentials |
|
| 57 | + * @param string $identifier |
|
| 58 | + * @return int rows removed |
|
| 59 | + * @since 8.2.0 |
|
| 60 | + */ |
|
| 61 | + public function delete($userId, $identifier); |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Erase all credentials stored for a user |
|
| 65 | - * |
|
| 66 | - * @param string $userId |
|
| 67 | - * @return int rows removed |
|
| 68 | - * @since 8.2.0 |
|
| 69 | - */ |
|
| 70 | - public function erase($userId); |
|
| 63 | + /** |
|
| 64 | + * Erase all credentials stored for a user |
|
| 65 | + * |
|
| 66 | + * @param string $userId |
|
| 67 | + * @return int rows removed |
|
| 68 | + * @since 8.2.0 |
|
| 69 | + */ |
|
| 70 | + public function erase($userId); |
|
| 71 | 71 | |
| 72 | 72 | } |
@@ -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 | } |
@@ -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 | } |