reference/stream/functions/stream-context-set-params.xml
d715365c098db000eaf7dcd987ee6093f6e83091
d715365c098db000eaf7dcd987ee6093f6e83091
...
...
@@ -9,8 +9,8 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>bool</type><methodname>stream_context_set_params</methodname>
13
-
<methodparam><type>resource</type><parameter>stream_or_context</parameter></methodparam>
12
+
<type>true</type><methodname>stream_context_set_params</methodname>
13
+
<methodparam><type>resource</type><parameter>context</parameter></methodparam>
14
14
<methodparam><type>array</type><parameter>params</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<para>
...
...
@@ -23,7 +23,7 @@
23
23
<para>
24
24
<variablelist>
25
25
<varlistentry>
26
-
<term><parameter>stream_or_context</parameter></term>
26
+
<term><parameter>context</parameter></term>
27
27
<listitem>
28
28
<para>
29
29
The stream or context to apply the parameters too.
...
...
@@ -34,51 +34,46 @@
34
34
<term><parameter>params</parameter></term>
35
35
<listitem>
36
36
<para>
37
-
An array of parameters to set.
37
+
An associative array of parameters to be set in the following format:
38
+
<literal>$params['paramname'] = "paramvalue";</literal>.
38
39
</para>
39
-
<note>
40
-
<para>
41
-
<parameter>params</parameter> should be an associative array of the structure:
42
-
<literal>$params['paramname'] = "paramvalue";</literal>.
43
-
</para>
44
-
</note>
40
+
<table>
41
+
<title>Supported parameters</title>
42
+
<tgroup cols="2">
43
+
<thead>
44
+
<row>
45
+
<entry>Parameter</entry>
46
+
<entry>Purpose</entry>
47
+
</row>
48
+
</thead>
49
+
<tbody>
50
+
<row>
51
+
<entry>
52
+
<literal>notification</literal>
53
+
</entry>
54
+
<entry>
55
+
Name of user-defined callback function to be called whenever a stream triggers a notification.
56
+
Only supported for <link linkend="wrappers.http">http://</link> and
57
+
<link linkend="wrappers.ftp">ftp://</link> stream wrappers.
58
+
</entry>
59
+
</row>
60
+
<row>
61
+
<entry>
62
+
<literal>options</literal>
63
+
</entry>
64
+
<entry>
65
+
Array of options as in <link linkend="context">context options and parameters</link>.
66
+
</entry>
67
+
</row>
68
+
</tbody>
69
+
</tgroup>
70
+
</table>
45
71
</listitem>
46
72
</varlistentry>
47
73
</variablelist>
48
74
</para>
49
75
</refsect1><!-- }}} -->
50
76
51
-
<refsect1 role="options"><!-- {{{ -->
52
-
<title>Supported parameters</title>
53
-
<informaltable>
54
-
<tgroup cols="2">
55
-
<thead>
56
-
<row>
57
-
<entry>Parameters</entry>
58
-
<entry>Purpose</entry>
59
-
</row>
60
-
</thead>
61
-
<tbody>
62
-
<row>
63
-
<entry><literal>notification</literal></entry>
64
-
<entry>
65
-
Name of user-defined callback function to be called whenever a stream triggers a notification.
66
-
Only supported for <link linkend="wrappers.http">http://</link> and
67
-
<link linkend="wrappers.ftp">ftp://</link> stream wrappers.
68
-
</entry>
69
-
</row>
70
-
<row>
71
-
<entry><literal>options</literal></entry>
72
-
<entry>
73
-
Array of options as in <link linkend="context">context options and
74
-
parameters</link>.
75
-
</entry>
76
-
</row>
77
-
</tbody>
78
-
</tgroup>
79
-
</informaltable>
80
-
</refsect1><!-- }}} -->
81
-
82
77
<refsect1 role="returnvalues"><!-- {{{ -->
83
78
&reftitle.returnvalues;
84
79
<para>
...
...
@@ -94,7 +89,6 @@
94
89
</refsect1><!-- }}} -->
95
90
96
91
</refentry>
97
-
98
92
<!-- Keep this comment at the end of the file
99
93
Local variables:
100
94
mode: sgml
101
95