add missing docs
authorMichael Wallner <mike@php.net>
Wed, 13 Mar 2019 13:50:11 +0000 (14:50 +0100)
committerMichael Wallner <mike@php.net>
Wed, 13 Mar 2019 13:50:11 +0000 (14:50 +0100)
http/Encoding/Stream/Debrotli.md [new file with mode: 0644]
http/Encoding/Stream/Debrotli/decode.md [new file with mode: 0644]
http/Encoding/Stream/Enbrotli.md [new file with mode: 0644]
http/Encoding/Stream/Enbrotli/encode.md [new file with mode: 0644]
http/QueryString/__toString.md [new file with mode: 0644]

diff --git a/http/Encoding/Stream/Debrotli.md b/http/Encoding/Stream/Debrotli.md
new file mode 100644 (file)
index 0000000..70cd366
--- /dev/null
@@ -0,0 +1,14 @@
+# class http\Encoding\Stream\Debrotli extends http\Encoding\Stream
+
+A [brotli](https://brotli.org) decoding stream.
+
+> ***NOTE:***  
+> This class has been added in v3.2.0.
+
+## Constants:
+
+None.
+
+## Properties:
+
+None.
diff --git a/http/Encoding/Stream/Debrotli/decode.md b/http/Encoding/Stream/Debrotli/decode.md
new file mode 100644 (file)
index 0000000..598c778
--- /dev/null
@@ -0,0 +1,16 @@
+# static string http\Encoding\Stream\Debrotli::decode(string $data)
+
+Decode brotli encoded data.
+
+## Params:
+
+* string $data  
+  The data to uncompress.
+
+## Returns:
+
+* string, the uncompressed data.
+
+## Warnings:
+
+* If $data cannot be decoded.
diff --git a/http/Encoding/Stream/Enbrotli.md b/http/Encoding/Stream/Enbrotli.md
new file mode 100644 (file)
index 0000000..7ab7576
--- /dev/null
@@ -0,0 +1,31 @@
+# class http\Encoding\Stream\Enbrotli extends http\Encoding\Stream
+
+A [brotli](https://brotli.org) encoding stream.
+
+> ***NOTE:***  
+> This class has been added in v3.2.0.
+
+## Constants:
+
+* LEVEL_DEF  
+  Default compression level.
+* LEVEL_MIN  
+  Least compression level.
+* LEVEL_MAX  
+  Greatest compression level.
+* WBITS_DEF  
+  Default window bits.
+* WBITS_MIN  
+  Minimum window bits.
+* WBITS_MAX  
+  Maximum window bits.
+* MODE_GENERIC  
+  Default compression mode.
+* MODE_TEXT  
+  Compression mode for UTF-8 formatted text.
+* MODE_FONT  
+  Compression mode used in WOFF 2.0.
+
+## Properties:
+
+None.
diff --git a/http/Encoding/Stream/Enbrotli/encode.md b/http/Encoding/Stream/Enbrotli/encode.md
new file mode 100644 (file)
index 0000000..c351e0c
--- /dev/null
@@ -0,0 +1,18 @@
+# static string http\Encoding\Stream\Enbrotli::encode(string $data[, int $flags = 0])
+
+Encode data with brotli encoding.
+
+## Params:
+
+* string $data  
+  The data to compress.
+* Optional int $flags = 0  
+  Any compression tuning flags. See http\Encoding\Stream\Enbrotli and http\Encoding\Stream constants.
+
+## Returns:
+
+* string, the compressed data.
+
+## Warnings:
+
+* If $data cannot be encoded.
diff --git a/http/QueryString/__toString.md b/http/QueryString/__toString.md
new file mode 100644 (file)
index 0000000..60d0c87
--- /dev/null
@@ -0,0 +1,11 @@
+# string http\QueryString::__toString()
+
+Get the string representation of the querystring (x-www-form-urlencoded).
+
+## Params:
+
+None.
+
+## Returns:
+
+* string, the x-www-form-urlencoded querystring.