X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=http%2FHeader%2FParser%2Fparse.md;fp=http%2FHeader%2FParser%2Fparse.md;h=444a1b33da1a6ba80425534a3a5c90c8753ee776;hb=91c46438fed4c472407edaafe11442e4697317a4;hp=0000000000000000000000000000000000000000;hpb=961f8a1687d70d07e07979cdd0c725f62ac4121f;p=mdref%2Fmdref-http

diff --git a/http/Header/Parser/parse.md b/http/Header/Parser/parse.md
new file mode 100644
index 0000000..444a1b3
--- /dev/null
+++ b/http/Header/Parser/parse.md
@@ -0,0 +1,76 @@
+# int http\Header\Parser::parse(string $data, int $flags, array &$message = NULL)
+
+Parse a string.
+
+## Params:
+
+* string $data  
+  The (part of the) header to parse.
+* int $flags  
+  Any combination of [parser flags](http/Header/Parser#Parser.flags:).
+* array &$header = NULL 
+  Successfully parsed headers.
+
+## Returns:
+
+* int, http\Header\Parser::STATE_* constant.
+
+## Throws:
+
+* http\Exception\InvalidArgumentException
+
+## Example:
+
+	<?php
+	
+	$headers = [
+		"One: ","header\n",
+		"Two: header\n\tlines\n",
+		"Three",": header\n lines\n here\n",
+		"More: than one header\n",
+		"More: ", "than: ", "you: ", "expect\n",
+		"\n",
+	];
+
+	$states = [-1=>"FAILURE",0=>"START","KEY","VALUE","VALUE_EX","HEADER_DONE","DONE"];
+	$parser = new http\Header\Parser;
+	do {
+		$state = $parser->parse($part = array_shift($headers), 
+			$headers ? 0 : http\Header\Parser::CLEANUP, 
+			$result);
+		printf("%2\$-32s | %1\$s\n", $states[$state], addcslashes($part, "\r\n\t\0"));
+	} while ($headers && $state !== http\Header\Parser::STATE_FAILURE);
+
+	var_dump($result);
+
+	?>
+
+Yields:
+
+	Test
+	One:                             | VALUE
+	header\n                         | VALUE_EX
+	Two: header\n\tlines\n           | VALUE_EX
+	Three                            | KEY
+	: header\n lines\n here\n        | VALUE_EX
+	More: than one header\n          | VALUE_EX
+	More:                            | VALUE
+	than:                            | VALUE
+	you:                             | VALUE
+	expect\n                         | VALUE_EX
+	\n                               | DONE
+	array(4) {
+	  ["One"]=>
+	  string(6) "header"
+	  ["Two"]=>
+	  string(12) "header lines"
+	  ["Three"]=>
+	  string(17) "header lines here"
+	  ["More"]=>
+	  array(2) {
+		[0]=>
+		string(15) "than one header"
+		[1]=>
+		string(17) "than: you: expect"
+	  }
+	}