mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-10 05:34:54 +00:00
Code Issues Projects Releases Wiki Activity

Internet: fix type information for getURL(), postURL() and simpleCurl()

Browse Source
This commit is contained in:
Dylan K. Taylor 2020-01-29 20:20:52 +00:00
parent 64b3d02974
commit 9e6cbb5b6a
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/pocketmine/utils/Internet.php
View File

@ -134,10 +134,11 @@ class Internet{
* GETs an URL using cURL
* NOTE: This is a blocking operation and can take a significant amount of time. It is inadvisable to use this method on the main thread.
*
* @param int $timeout default 10
* @param string $err reference parameter, will be set to the output of curl_error(). Use this to retrieve errors that occured during the operation.
* @param array[] $headers reference parameter
* @param int $httpCode reference parameter
* @param int $timeout default 10
* @param string[] $extraHeaders
* @param string $err reference parameter, will be set to the output of curl_error(). Use this to retrieve errors that occured during the operation.
* @param string[] $headers reference parameter
* @param int $httpCode reference parameter
*
* @return bool|mixed false if an error occurred, mixed data if successful.
*/
@ -156,8 +157,9 @@ class Internet{
* NOTE: This is a blocking operation and can take a significant amount of time. It is inadvisable to use this method on the main thread.
*
* @param array|string $args
* @param string[] $extraHeaders
* @param string $err reference parameter, will be set to the output of curl_error(). Use this to retrieve errors that occured during the operation.
* @param array[] $headers reference parameter
* @param string[] $headers reference parameter
* @param int $httpCode reference parameter
*
* @return bool|mixed false if an error occurred, mixed data if successful.
@ -185,7 +187,7 @@ class Internet{
* @param callable|null $onSuccess function to be called if there is no error. Accepts a resource argument as the cURL handle.
* @phpstan-param (callable(resource) : void)|null $onSuccess
*
* @return array a plain array of three [result body : string, headers : array[], HTTP response code : int]. Headers are grouped by requests with strtolower(header name) as keys and header value as values
* @return array a plain array of three [result body : string, headers : string[], HTTP response code : int]. Headers are grouped by requests with strtolower(header name) as keys and header value as values
*
* @throws InternetException if a cURL error occurs
*/

14
src/pocketmine/utils/Utils.php
View File

@ -420,10 +420,11 @@ class Utils{
* @deprecated
* @see Internet::getURL()
*
* @param int $timeout default 10
* @param string $err reference parameter, will be set to the output of curl_error(). Use this to retrieve errors that occured during the operation.
* @param array[] $headers reference parameter
* @param int $httpCode reference parameter
* @param int $timeout default 10
* @param string[] $extraHeaders
* @param string $err reference parameter, will be set to the output of curl_error(). Use this to retrieve errors that occured during the operation.
* @param string[] $headers reference parameter
* @param int $httpCode reference parameter
*
* @return bool|mixed false if an error occurred, mixed data if successful.
*/
@ -436,8 +437,9 @@ class Utils{
* @see Internet::postURL()
*
* @param array|string $args
* @param string[] $extraHeaders
* @param string $err reference parameter, will be set to the output of curl_error(). Use this to retrieve errors that occured during the operation.
* @param array[] $headers reference parameter
* @param string[] $headers reference parameter
* @param int $httpCode reference parameter
*
* @return bool|mixed false if an error occurred, mixed data if successful.
@ -456,7 +458,7 @@ class Utils{
* @param callable|null $onSuccess function to be called if there is no error. Accepts a resource argument as the cURL handle.
* @phpstan-param (callable(resource) : void)|null $onSuccess
*
* @return array a plain array of three [result body : string, headers : array[], HTTP response code : int]. Headers are grouped by requests with strtolower(header name) as keys and header value as values
* @return array a plain array of three [result body : string, headers : string[], HTTP response code : int]. Headers are grouped by requests with strtolower(header name) as keys and header value as values
*
* @throws \RuntimeException if a cURL error occurs
*/