Merge branch 'NewFeatures' into Features-DB_IO_SQLite

www/lib/CoreLibs/UrlRequests/CurlTrait.php

@@ -0,0 +1,128 @@
+<?php
+
+/**
+ * AUTHOR: Clemens Schwaighofer
+ * CREATED: 2024/10/29
+ * DESCRIPTION:
+ * Curl Client Trait for get/post/put/delete requests through the php curl inteface
+ *
+ * For anything more complex use guzzlehttp/http
+ * https://docs.guzzlephp.org/en/stable/index.html
+*/
+
+// phpcs:disable Generic.Files.LineLength
+
+declare(strict_types=1);
+
+namespace CoreLibs\UrlRequests;
+
+trait CurlTrait
+{
+	/**
+	 * combined set call for any type of request with options type parameters
+	 * The following options can be set:
+	 * header: as array string:string
+	 * query as string or array string:string
+	 * body as string or array of any type
+	 *
+	 * @param  string $type What type of request we send, will throw exception if not a valid one
+	 * @param  string $url  The url to send
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Request options
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} [default=[]] Result code, headers and content as array, content is json
+	 * @throws \UnexpectedValueException on missing body data when body data is needed
+	 */
+	abstract public function request(string $type, string $url, array $options = []): array;
+
+	/**
+	 * Makes an request to the target url via curl: GET
+	 * Returns result as string (json)
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} [default=[]] Result code, headers and content as array, content is json
+	 */
+	public function get(string $url, array $options = []): array
+	{
+		return $this->request(
+			"get",
+			$url,
+			$options,
+		);
+	}
+
+	/**
+	 * Makes an request to the target url via curl: POST
+	 * Returns result as string (json)
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} Result code, headers and content as array, content is json
+	 */
+	public function post(string $url, array $options): array
+	{
+		return $this->request(
+			"post",
+			$url,
+			$options,
+		);
+	}
+
+	/**
+	 * Makes an request to the target url via curl: PUT
+	 * Returns result as string (json)
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} Result code, headers and content as array, content is json
+	 */
+	public function put(string $url, array $options): array
+	{
+		return $this->request(
+			"put",
+			$url,
+			$options,
+		);
+	}
+
+	/**
+	 * Makes an request to the target url via curl: PATCH
+	 * Returns result as string (json)
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} Result code, headers and content as array, content is json
+	 */
+	public function patch(string $url, array $options): array
+	{
+		return $this->request(
+			"patch",
+			$url,
+			$options,
+		);
+	}
+
+	/**
+	 * Makes an request to the target url via curl: DELETE
+	 * Returns result as string (json)
+	 * Note that DELETE body is optional
+	 *
+	 * @param  string                          $url     The URL being requested,
+	 *                                                  including domain and protocol
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options Options to set
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} [default=[]] Result code, headers and content as array, content is json
+	 */
+	public function delete(string $url, array $options = []): array
+	{
+		return $this->request(
+			"delete",
+			$url,
+			$options,
+		);
+	}
+}
+
+// __END__

www/lib/CoreLibs/UrlRequests/Interface/RequestsInterface.php

@@ -0,0 +1,83 @@
+<?php
+
+/**
+ * AUTHOR: Clemens Schwaighofer
+ * CREATED: 2024/9/20
+ * DESCRIPTION:
+ * URL Requests client interface
+*/
+
+namespace CoreLibs\UrlRequests\Interface;
+
+interface RequestsInterface
+{
+	/**
+	 * get the config array with all settings
+	 *
+	 * @return array<string,mixed> all current config settings
+	 */
+	public function getConfig(): array;
+
+	/**
+	 * Return the full url as it was sent
+	 *
+	 * @return string url sent
+	 */
+	public function getUrlSent(): string;
+
+	/**
+	 * get the parsed url
+	 *
+	 * @return array{scheme?:string,user?:string,host?:string,port?:string,path?:string,query?:string,fragment?:string,pass?:string}
+	 */
+	public function getUrlParsedSent(): array;
+
+	/**
+	 * Return the full headers as they where sent
+	 *
+	 * @return array<string,string>
+	 */
+	public function getHeadersSent(): array;
+
+	/**
+	 * set, add or overwrite header
+	 * On default this will overwrite header, and not set
+	 *
+	 * @param  array<string,string|array<string>> $header
+	 * @param  bool                               $add [default=false] if set will add header to existing value
+	 * @return void
+	 */
+	public function setHeaders(array $header, bool $add = false): void;
+
+	/**
+	 * remove header entry
+	 * if key is only set then match only key, if both are set both sides must match
+	 *
+	 * @param  array<string,string> $remove_headers
+	 * @return void
+	 */
+	public function removeHeaders(array $remove_headers): void;
+
+	/**
+	 * Update the base url set, if empty will unset the base url
+	 *
+	 * @param  string $base_uri
+	 * @return void
+	 */
+	public function setBaseUri(string $base_uri): void;
+
+	/**
+	 * combined set call for any type of request with options type parameters
+	 *
+	 * phpcs:disable Generic.Files.LineLength
+	 * @param  string $type
+	 * @param  string $url
+	 * @param  array{auth?:null|array{0:string,1:string,2:string},headers?:null|array<string,string|array<string>>,query?:null|array<string,string>,body?:null|string|array<mixed>,http_errors?:null|bool} $options
+	 * @return array{code:string,headers:array<string,array<string>>,content:string} Result code, headers and content as array, content is json
+	 * @throws \UnexpectedValueException on missing body data when body data is needed
+	 * phpcs:enable Generic.Files.LineLength
+	 */
+	public function request(string $type, string $url, array $options = []): array;
+}
+
+// __END__