Upload files using FormData (#214)

* wip: add formdata class

* wip: add urlsearchparams class

* feature: implement URLSearchParams

* feature: tweak urlsearchparams

* wip: extract KeyValuePairStore

* wip: implement KeyValuePairStore for FormData

* wip: improve tests by expecting warning to be emitted

* wip: empty formdata options

* wip: test submitter is included in the form submission

* wip: test constructing with square brackets

* wip: fix static analysis error on DOMNodeList

* wip: implement form types

* wip: remove unused constants

* feature: implement promise-based functions
closes #208

* test: improve static tests

* wip: uploading of files for #213

Author: Greg Bowler

composer.json

@@ -14,6 +14,7 @@
 		"php": ">=8.1",
 		"ext-dom": "*",
 		"ext-curl": "*",
+		"ext-fileinfo": "*",
 		"phpgt/input": "^1.2",
 		"phpgt/typesafegetter": "^1.3",
 		"phpgt/promise": "^2.2",

src/File.php

@@ -1,17 +1,29 @@
 <?php
 namespace Gt\Http;
 
+use SplFileObject;
+
 class File extends Blob {
 	/**
 	 * @param array<ArrayBuffer|Blob|string> $bits
 	 * @param string $name
 	 * @param array<string, string> $options
 	 */
 	public function __construct(
-		array $bits,
+		SplFileObject|array $bits,
 		string $name,
 		array $options = [],
 	) {
+		if($bits instanceof SplFileObject) {
+			$file = $bits;
+			$bits = [];
+			while(!$file->eof()) {
+				array_push($bits, $file->fread(1024));
+			}
+		}
+
+		/** @var array<ArrayBuffer|Blob|string> $bits */
+
 		parent::__construct($bits, $options);
 		$this->name = $name;
 	}

src/FormData.php

@@ -6,6 +6,7 @@
 use DOMXPath;
 use Generator;
 use Gt\TypeSafeGetter\NullableTypeSafeGetter;
+use SplFileObject;
 use Stringable;
 use Countable;
 use Iterator;
@@ -104,17 +105,19 @@ public function getBlob(string $name):?Blob {
 	 */
 	public function append(
 		string $name,
-		Blob|File|string $value,
+		Blob|File|SplFileObject|string $value,
 		string $filename = null
 	):void {
+		$value = $this->normaliseFileValue($value);
 		$this->appendAnyValue($name, $value, $filename);
 	}
 
 	public function set(
 		string $name,
-		Blob|File|string $value,
+		Blob|File|SplFileObject|string $value,
 		?string $filename = null,
 	):void {
+		$value = $this->normaliseFileValue($value);
 		$this->setAnyValue($name, $value, $filename);
 	}
 
@@ -183,4 +186,14 @@ private function getValueFromSelect(DOMElement $select):string {
 
 		return "";
 	}
+
+	private function normaliseFileValue(Blob|File|SplFileObject|string $value):Blob|File|string {
+		if(!$value instanceof SplFileObject) {
+			return $value;
+		}
+
+		/** @var SplFileObject $file */
+		$file = $value;
+		return new File($file, $file->getFilename());
+	}
 }

src/KeyValuePairStore.php

@@ -2,6 +2,7 @@
 namespace Gt\Http;
 
 use Generator;
+use SplFileObject;
 
 /** @SuppressWarnings("TooManyPublicMethods") */
 abstract class KeyValuePairStore {