From 3f8a4bc587ecf07b4d81c5fabafd0f2783802b25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1t=C3=A9=20Kocsis?= Date: Thu, 12 Dec 2024 07:23:18 +0100 Subject: [PATCH 1/5] Synchronize manual with stubs for PHP 8.4 - part 10 --- .../stream/functions/stream-bucket-append.xml | 26 +++- .../stream-bucket-make-writeable.xml | 42 +++++- .../stream/functions/stream-bucket-new.xml | 26 +++- .../functions/stream-bucket-prepend.xml | 26 +++- reference/stream/streambucket.xml | 123 ++++++++++++++++++ reference/stream/versions.xml | 1 + 6 files changed, 234 insertions(+), 10 deletions(-) create mode 100644 reference/stream/streambucket.xml diff --git a/reference/stream/functions/stream-bucket-append.xml b/reference/stream/functions/stream-bucket-append.xml index 524e934e7cab..c69ab87abb76 100644 --- a/reference/stream/functions/stream-bucket-append.xml +++ b/reference/stream/functions/stream-bucket-append.xml @@ -13,15 +13,37 @@ voidstream_bucket_append resourcebrigade - objectbucket + StreamBucketbucket &warn.undocumented.func; - + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 8.4.0 + + bucket expects a StreamBucket + instance now; previously, an stdClass was expected. + + + + + + + + + + The StreamBucket class + StreamBucket + + + +
+ &reftitle.intro; + + A stream bucket is a chunk of stream which can be extracted from bucket brigades. + +
+ +
+ &reftitle.classsynopsis; + + + + final + StreamBucket + + + &Properties; + + public + readonly + resource + bucket + + + public + readonly + string + data + + + public + readonly + int + datalen + + + public + readonly + int + dataLength + + +
+ +
+ &reftitle.properties; + + + resource bucket + + A userfilter.bucket resource. + + + + string data + + The current string in the bucket. + + + + int datalen + + + The length of the string in the bucket. + Deprecated as of PHP 8.4 in favor of StreamBucket::$dataLength. + + + + + int dataLength + + The length of the string in the bucket. + + + +
+ +
+ &reftitle.seealso; + + + stream_bucket_new + stream_bucket_append + stream_bucket_prepend + stream_bucket_make_writeable + + +
+ + + + &reference.stream.entities.streambucket; + + + diff --git a/reference/stream/versions.xml b/reference/stream/versions.xml index bf32d0b61cc9..337b416ffa7b 100644 --- a/reference/stream/versions.xml +++ b/reference/stream/versions.xml @@ -4,6 +4,7 @@ Do NOT translate this file --> + From dae9b526528fd36dd2a73e4f30efd8dd825693be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1t=C3=A9=20Kocsis?= Date: Thu, 12 Dec 2024 22:34:41 +0100 Subject: [PATCH 2/5] Address review comments --- .../stream-bucket-make-writeable.xml | 38 +------------------ reference/stream/streambucket.xml | 32 ++++++++-------- 2 files changed, 17 insertions(+), 53 deletions(-) diff --git a/reference/stream/functions/stream-bucket-make-writeable.xml b/reference/stream/functions/stream-bucket-make-writeable.xml index 9f8ab5163277..4aa82bf18a6e 100644 --- a/reference/stream/functions/stream-bucket-make-writeable.xml +++ b/reference/stream/functions/stream-bucket-make-writeable.xml @@ -40,43 +40,7 @@ &reftitle.returnvalues; - Returns a bucket object with the properties listed below or &null;. - - - - data - (string) - - - - data bucket The current string in the bucket. - - - - - - dataLength - (int) - - - - dataLength bucket The length of the string in the bucket. - - - - - - datalen - (int) - - - - datalen bucket The length of the string in the bucket. Deprecated as of PHP 8.4 - in favor of StreamBucket::$dataLength. - - - - + Returns a bucket object or &null;. diff --git a/reference/stream/streambucket.xml b/reference/stream/streambucket.xml index 0e87f0cb5813..8600a9171df2 100644 --- a/reference/stream/streambucket.xml +++ b/reference/stream/streambucket.xml @@ -57,44 +57,44 @@ resource bucket - A userfilter.bucket resource. + A userfilter.bucket resource. string data - The current string in the bucket. + The current string in the bucket. int datalen - + The length of the string in the bucket. Deprecated as of PHP 8.4 in favor of StreamBucket::$dataLength. - + int dataLength - The length of the string in the bucket. + The length of the string in the bucket. -
- &reftitle.seealso; - - - stream_bucket_new - stream_bucket_append - stream_bucket_prepend - stream_bucket_make_writeable - - -
+
+ &reftitle.seealso; + + + stream_bucket_new + stream_bucket_append + stream_bucket_prepend + stream_bucket_make_writeable + + +
From 3a5d6af243a3c6e24ecd2d47dcd9b698d2942eff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1t=C3=A9=20Kocsis?= Date: Thu, 12 Dec 2024 22:35:17 +0100 Subject: [PATCH 3/5] Update reference/stream/streambucket.xml Co-authored-by: Christoph M. Becker --- reference/stream/streambucket.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/stream/streambucket.xml b/reference/stream/streambucket.xml index 8600a9171df2..0effddaa647f 100644 --- a/reference/stream/streambucket.xml +++ b/reference/stream/streambucket.xml @@ -9,9 +9,9 @@
&reftitle.intro; - - A stream bucket is a chunk of stream which can be extracted from bucket brigades. - + + A stream bucket is a chunk of a stream which can be extracted from bucket brigades. +
From a6634388680dafd902a6bb0f8151a4441d2d702d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1t=C3=A9=20Kocsis?= Date: Thu, 12 Dec 2024 22:36:38 +0100 Subject: [PATCH 4/5] Remove tag --- reference/stream/streambucket.xml | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/reference/stream/streambucket.xml b/reference/stream/streambucket.xml index 0effddaa647f..f49539fe04b2 100644 --- a/reference/stream/streambucket.xml +++ b/reference/stream/streambucket.xml @@ -86,14 +86,12 @@
&reftitle.seealso; - - - stream_bucket_new - stream_bucket_append - stream_bucket_prepend - stream_bucket_make_writeable - - + + stream_bucket_new + stream_bucket_append + stream_bucket_prepend + stream_bucket_make_writeable +
From 2f2fd66eb40de813093f61dffcd0ca724c3745bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1t=C3=A9=20Kocsis?= Date: Sat, 14 Dec 2024 10:06:59 +0100 Subject: [PATCH 5/5] Use entities --- language-snippets.ent | 3 +++ reference/stream/functions/stream-bucket-append.xml | 5 +---- reference/stream/functions/stream-bucket-make-writeable.xml | 5 +---- reference/stream/functions/stream-bucket-new.xml | 5 +---- reference/stream/functions/stream-bucket-prepend.xml | 5 +---- 5 files changed, 7 insertions(+), 16 deletions(-) diff --git a/language-snippets.ent b/language-snippets.ent index 26bb4819a0ed..8a8cc544e56e 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -2675,6 +2675,9 @@ objects. Otherwise, a PharException will be thrown.streamWrapper::$context property is updated if a valid context is passed to the caller function.'> +bucket expects a StreamBucket instance now; previously, an stdClass was expected.'> +StreamBucket instance now; previously, an stdClass was returned.'> + 8.4.0 - - bucket expects a StreamBucket - instance now; previously, an stdClass was expected. - + &stream.bucket.param; diff --git a/reference/stream/functions/stream-bucket-make-writeable.xml b/reference/stream/functions/stream-bucket-make-writeable.xml index 4aa82bf18a6e..66c33a4d9b85 100644 --- a/reference/stream/functions/stream-bucket-make-writeable.xml +++ b/reference/stream/functions/stream-bucket-make-writeable.xml @@ -57,10 +57,7 @@ 8.4.0 - - This function returns a StreamBucket instance now; - previously, an stdClass was returned. - + &stream.bucket.return; diff --git a/reference/stream/functions/stream-bucket-new.xml b/reference/stream/functions/stream-bucket-new.xml index 370a5d1630cd..ee701734deed 100644 --- a/reference/stream/functions/stream-bucket-new.xml +++ b/reference/stream/functions/stream-bucket-new.xml @@ -33,10 +33,7 @@ 8.4.0 - - This function returns a StreamBucket instance now; - previously, an stdClass was returned. - + &stream.bucket.return; diff --git a/reference/stream/functions/stream-bucket-prepend.xml b/reference/stream/functions/stream-bucket-prepend.xml index c36f3038af9d..31c3572a3e49 100644 --- a/reference/stream/functions/stream-bucket-prepend.xml +++ b/reference/stream/functions/stream-bucket-prepend.xml @@ -63,10 +63,7 @@ 8.4.0 - - bucket expects a StreamBucket - instance now; previously, an stdClass was expected. - + &stream.bucket.param;