[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] [doc-en] master: [PHP 8.3] New stream_context_set_options function (#2947)
From:       Sergey Panteleev via GitHub <noreply () php ! net>
Date:       2023-11-18 8:34:49
Message-ID: ccKjlT3PEKqWlwdaYtsxcPjVTUYyW665xlD2AHPfRtU () main ! php ! net
[Download RAW message or body]

Author: Sergey Panteleev (saundefined)
Committer: GitHub (web-flow)
Pusher: saundefined
Date: 2023-11-18T11:21:11+03:00

Commit: https://github.com/php/doc-en/commit/4d8c71986e0759b99cba7530e8045bd21fcae055
Raw diff: https://github.com/php/doc-en/commit/4d8c71986e0759b99cba7530e8045bd21fcae055.diff


[PHP 8.3] New stream_context_set_options function (#2947)

Co-authored-by: Gina Peter Banyard <girgias@php.net>

Changed paths:
  A  reference/stream/functions/stream-context-set-options.xml
  M  reference/stream/versions.xml


Diff:

diff --git a/reference/stream/functions/stream-context-set-options.xml \
b/reference/stream/functions/stream-context-set-options.xml new file mode 100644
index 00000000000..20ab886197a
--- /dev/null
+++ b/reference/stream/functions/stream-context-set-options.xml
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="function.stream-context-set-options" \
xmlns="http://docbook.org/ns/docbook"> + <refnamediv>
+  <refname>stream_context_set_options</refname>
+  <refpurpose>Sets options on the specified context</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>stream_context_set_options</methodname>
+   <methodparam><type>resource</type><parameter>context</parameter></methodparam>
+   <methodparam><type>array</type><parameter>options</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Sets options on the specified context.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>context</parameter></term>
+     <listitem>
+      <para>
+       The stream or context resource to apply the options to.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>options</parameter></term>
+     <listitem>
+      <para>
+       The options to set for <parameter>context</parameter>.
+      </para>
+      <note>
+       <para>
+        <parameter>options</parameter> must be an associative
+        &array; of associative arrays in the format
+        <code>$array['wrapper']['option'] = $value</code>.
+       </para>
+       <para>
+        Refer to <link linkend="context">context options and parameters</link>
+        for a listing of stream options.
+       </para>
+      </note>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>stream_context_set_options</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+
+$context = stream_context_create();
+
+$options = [
+    'http' => [
+        'protocol_version' => 1.1,
+        'user_agent' => 'PHPT Agent',
+    ],
+];
+
+stream_context_set_options($context, $options);
+var_dump(stream_context_get_options($context));
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+array(1) {
+  ["http"]=>
+  array(2) {
+    ["protocol_version"]=>
+    float(1.1)
+    ["user_agent"]=>
+    string(10) "PHPT Agent"
+  }
+}
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>stream_context_set_option</methodname></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/stream/versions.xml b/reference/stream/versions.xml
index aa972b35554..bf32d0b61cc 100644
--- a/reference/stream/versions.xml
+++ b/reference/stream/versions.xml
@@ -14,6 +14,7 @@
  <function name="stream_context_get_params" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
  <function name="stream_context_set_default" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP \
8"/>  <function name="stream_context_set_option" from="PHP 4 &gt;= 4.3.0, PHP 5, PHP \
7, PHP 8"/> + <function name="stream_context_set_options" from="PHP 8 &gt;= 8.3.0"/>
  <function name="stream_context_set_params" from="PHP 4 &gt;= 4.3.0, PHP 5, PHP 7, \
PHP 8"/>  <function name="stream_copy_to_stream" from="PHP 5, PHP 7, PHP 8"/>
  <function name="stream_filter_append" from="PHP 4 &gt;= 4.3.0, PHP 5, PHP 7, PHP \
8"/>

-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


[prev in list] [next in list] [prev in thread] [next in thread]