reference/yaf/yaf_request_abstract/setparam.xml
b91741b2890ffede77890516280158f11c0c44cd
...
...
@@ -4,22 +4,19 @@
4
4
<refentry xml:id="yaf-request-abstract.setparam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
5
<refnamediv>
6
6
<refname>Yaf_Request_Abstract::setParam</refname>
7
-
<refpurpose>The setParam purpose</refpurpose>
7
+
<refpurpose>Set a calling parameter to a request</refpurpose>
8
8
</refnamediv>
9
9

10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<methodsynopsis>
13
-
<modifier>public</modifier> <type>void</type><methodname>Yaf_Request_Abstract::setParam</methodname>
13
+
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Request_Abstract::setParam</methodname>
14
14
<methodparam><type>string</type><parameter>name</parameter></methodparam>
15
15
<methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
-

18
+
Set a parameter to request, which can be retrieved by <methodname>Yaf_Request_Abstract::getParam</methodname>
19
19
</para>
20
-

21
-
&warn.undocumented.func;
22
-

23
20
</refsect1>
24
21

25
22
<refsect1 role="parameters">
...
...
@@ -51,6 +48,13 @@
51
48
</para>
52
49
</refsect1>
53
50

51
+
<refsect1 role="seealso">
52
+
&reftitle.seealso;
53
+
<simplelist>
54
+
<member><methodname>Yaf_Request_Abstract::getParam</methodname></member>
55
+
<member><methodname>Yaf_Request_Abstract::getParams</methodname></member>
56
+
</simplelist>
57
+
</refsect1>
54
58

55
59
</refentry>
56
60

57
61