diff --git a/www/lib/CoreLibs/UrlRequests/Curl.php b/www/lib/CoreLibs/UrlRequests/Curl.php index 6e088c4e..ed3f6294 100644 --- a/www/lib/CoreLibs/UrlRequests/Curl.php +++ b/www/lib/CoreLibs/UrlRequests/Curl.php @@ -93,16 +93,16 @@ class Curl implements Interface\RequestsInterface } /** - * Convert array params to json type string + * Convert array payload data to json type string * - * @param string|array $params + * @param string|array $payload * @return string */ - private function convertParams(string|array $params): string + private function convertPayloadData(string|array $payload): string { // convert to string as JSON block if it is an array - if (is_array($params)) { - $params = Json::jsonConvertArrayTo($params); + if (is_array($payload)) { + $params = Json::jsonConvertArrayTo($payload); } return $params; } @@ -341,22 +341,22 @@ class Curl implements Interface\RequestsInterface * * @param string $url The URL being requested, * including domain and protocol - * @param string|array $params String to pass on as POST - * @param array $headers Headers to be used in the request - * @param null|string|array $query Optinal query parameters, array will be converted + * @param string|array $payload Data to pass on as POST + * @param array $headers [default=[]] Headers to be used in the request + * @param null|string|array $query [default=null] Optinal query parameters, array will be converted * @return array{code:string,content:string} Result code and content as array, content is json */ public function requestPost( string $url, - string|array $params, - array $headers, + string|array $payload, + array $headers = [], null|string|array $query = null ): array { return $this->curlRequest( "post", $this->convertQuery($url, $query), $headers, - $this->convertParams($params) + $this->convertPayloadData($payload) ); } @@ -366,22 +366,22 @@ class Curl implements Interface\RequestsInterface * * @param string $url The URL being requested, * including domain and protocol - * @param string|array $params String to pass on as POST - * @param array $headers Headers to be used in the request - * @param null|string|array $query Optinal query parameters, array will be converted + * @param string|array $payload String to pass on as POST + * @param array $headers [default=[]] Headers to be used in the request + * @param null|string|array $query [default=null] Optinal query parameters, array will be converted * @return array{code:string,content:string} Result code and content as array, content is json */ public function requestPut( string $url, - string|array $params, - array $headers, + string|array $payload, + array $headers = [], null|string|array $query = null ): array { return $this->curlRequest( "put", $this->convertQuery($url, $query), $headers, - $this->convertParams($params) + $this->convertPayloadData($payload) ); } diff --git a/www/lib/CoreLibs/UrlRequests/Interface/RequestsInterface.php b/www/lib/CoreLibs/UrlRequests/Interface/RequestsInterface.php index 7e06120c..1d649199 100644 --- a/www/lib/CoreLibs/UrlRequests/Interface/RequestsInterface.php +++ b/www/lib/CoreLibs/UrlRequests/Interface/RequestsInterface.php @@ -17,11 +17,12 @@ interface RequestsInterface * * @param string $url The URL being requested, * including domain and protocol - * @param array $headers Headers to be used in the request - * @param null|string|array $query String to pass on as GET, if array will be converted + * @param array $headers [default=[]] Headers to be used in the request + * @param null|string|array $query [default=null] String to pass on as GET, + * if array will be converted * @return array{code:string,content:string} Result code and content as array, content is json */ - public function requestGet(string $url, array $headers, null|string|array $query = null): array; + public function requestGet(string $url, array $headers = [], null|string|array $query = null): array; /** * Makes an request to the target url via curl: POST @@ -29,15 +30,15 @@ interface RequestsInterface * * @param string $url The URL being requested, * including domain and protocol - * @param string|array $params String to pass on as POST - * @param array $headers Headers to be used in the request - * @param null|string|array $query URL query parameters + * @param string|array $payload Data to pass on as POST + * @param array $headers [default=[]] Headers to be used in the request + * @param null|string|array $query [default=null] Optinal query parameters, array will be converted * @return array{code:string,content:string} Result code and content as array, content is json */ public function requestPost( string $url, - string|array $params, - array $headers, + string|array $payload, + array $headers = [], null|string|array $query = null ): array; @@ -47,15 +48,15 @@ interface RequestsInterface * * @param string $url The URL being requested, * including domain and protocol - * @param string|array $params String to pass on as POST - * @param array $headers Headers to be used in the request - * @param null|string|array $query String to pass on as GET, if array will be converted + * @param string|array $payload Data to pass on as POST + * @param array $headers [default=[]] Headers to be used in the request + * @param null|string|array $query [default=null] Optinal query parameters, array will be converted * @return array{code:string,content:string} Result code and content as array, content is json */ public function requestPut( string $url, - string|array $params, - array $headers, + string|array $payload, + array $headers = [], null|string|array $query = null ): array; @@ -65,11 +66,12 @@ interface RequestsInterface * * @param string $url The URL being requested, * including domain and protocol - * @param array $headers Headers to be used in the request - * @param null|string|array $query String to pass on as GET, if array will be converted + * @param array $headers [default=[]] Headers to be used in the request + * @param null|string|array $query [default=null] String to pass on as GET, + * if array will be converted * @return array{code:string,content:string} Result code and content as array, content is json */ - public function requestDelete(string $url, array $headers, null|string|array $query = null): array; + public function requestDelete(string $url, array $headers = [], null|string|array $query = null): array; } // __END__