1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stream-context-set-option" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_context_set_option</refname>
<refpurpose>Sets an option for a stream/wrapper/context</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>stream_context_set_option</methodname>
<methodparam><type>resource</type><parameter>stream_or_context</parameter></methodparam>
<methodparam><type>string</type><parameter>wrapper</parameter></methodparam>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
The following alternative signature is deprecated as of PHP 8.4.0,
use <function>stream_context_set_options</function> instead.
<methodsynopsis>
<type>bool</type><methodname>stream_context_set_option</methodname>
<methodparam><type>resource</type><parameter>stream_or_context</parameter></methodparam>
<methodparam><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
</para>
<simpara>
Sets an option on the specified context. <parameter>value</parameter>
is set to <parameter>option</parameter> for <parameter>wrapper</parameter>
</simpara>
</refsect1>
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream_or_context</parameter></term>
<listitem>
<para>
The stream or context resource to apply the options to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wrapper</parameter></term>
<listitem>
<para>
The name of the wrapper (which may be different than the protocol).
Refer to <link linkend="context">context options and parameters</link>
for a listing of stream options.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The name of the option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value of the option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
The options to set for <parameter>stream_or_context</parameter>.
</para>
<note>
<para>
<parameter>options</parameter> must be an associative
array of associative arrays in the format
<literal>$arr['wrapper']['option'] = $value</literal>.
</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="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The alternative 2-parameter signature is now deprecated.
Use <function>stream_context_set_options</function> instead.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->
|
