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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 327529 $ -->
<refentry xml:id="yaf-response-abstract.prependbody" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Response_Abstract::prependBody</refname>
<refpurpose>The prependBody purpose</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Response_Abstract::prependBody</methodname>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
prepend a content to a exists content block
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>body</parameter></term>
<listitem>
<para>
content string
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
the content key, you can set a content with a key, if you don't
specific, then Yaf_Response_Abstract::DEFAULT_BODY will be used
<note>
<para>
this parameter is introduced as of 2.2.0
</para>
</note>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
bool
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>Yaf_Response_Abstract::prependBody</function>example</title>
<programlisting role="php">
<![CDATA[
<?php
$response = new Yaf_Response_Http();
$response->setBody("World")->prependBody("Hello ");
echo $response;
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Hello World
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Yaf_Response_Abstract::getBody</methodname></member>
<member><methodname>Yaf_Response_Abstract::setBody</methodname></member>
<member><methodname>Yaf_Response_Abstract::appendBody</methodname></member>
<member><methodname>Yaf_Response_Abstract::clearBody</methodname></member>
</simplelist>
</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
-->
|
