CoreLibs/development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Name update for params/query

Browse Source 
Order in methods
url: mandatory
payload: mandatory in post/put
header = []
query = ""

old "params" -> "payload"
This commit is contained in:
Clemens Schwaighofer
2024-10-21 09:52:49 +09:00
parent 934db50b3a
commit f781b5e55f
2 changed files with 35 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
www/lib/CoreLibs/UrlRequests/Curl.php
View File

@@ -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<string,mixed> $params
* @param string|array<string,mixed> $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<string,mixed> $params String to pass on as POST
* @param array<string> $headers Headers to be used in the request
* @param null|string|array<string,mixed> $query Optinal query parameters, array will be converted
* @param string|array<string,mixed> $payload Data to pass on as POST
* @param array<string> $headers [default=[]] Headers to be used in the request
* @param null|string|array<string,mixed> $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<string,mixed> $params String to pass on as POST
* @param array<string> $headers Headers to be used in the request
* @param null|string|array<string,mixed> $query Optinal query parameters, array will be converted
* @param string|array<string,mixed> $payload String to pass on as POST
* @param array<string> $headers [default=[]] Headers to be used in the request
* @param null|string|array<string,mixed> $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)
);
}

34
www/lib/CoreLibs/UrlRequests/Interface/RequestsInterface.php
View File

@@ -17,11 +17,12 @@ interface RequestsInterface
*
* @param string $url The URL being requested,
* including domain and protocol
* @param array<string> $headers Headers to be used in the request
* @param null|string|array<string,mixed> $query String to pass on as GET, if array will be converted
* @param array<string> $headers [default=[]] Headers to be used in the request
* @param null|string|array<string,mixed> $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<string,mixed> $params String to pass on as POST
* @param array<string> $headers Headers to be used in the request
* @param null|string|array<string,mixed> $query URL query parameters
* @param string|array<string,mixed> $payload Data to pass on as POST
* @param array<string> $headers [default=[]] Headers to be used in the request
* @param null|string|array<string,mixed> $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<string,mixed> $params String to pass on as POST
* @param array<string> $headers Headers to be used in the request
* @param null|string|array<string,mixed> $query String to pass on as GET, if array will be converted
* @param string|array<string,mixed> $payload Data to pass on as POST
* @param array<string> $headers [default=[]] Headers to be used in the request
* @param null|string|array<string,mixed> $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<string> $headers Headers to be used in the request
* @param null|string|array<string,mixed> $query String to pass on as GET, if array will be converted
* @param array<string> $headers [default=[]] Headers to be used in the request
* @param null|string|array<string,mixed> $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__