Skip to content

Commit f8c7796

Browse files
committed
Message had missing function and typo on function names and parameters. [ci skip]
1 parent 99f3de5 commit f8c7796

1 file changed

Lines changed: 18 additions & 10 deletions

File tree

user_guide_src/source/incoming/message.rst

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,31 @@ Class Reference
3636

3737
.. php:class:: CodeIgniter\\HTTP\\Message
3838
39-
.. php:method:: body()
39+
.. php:method:: getBody()
4040
4141
:returns: The current message body
4242
:rtype: mixed
4343

4444
Returns the current message body, if any has been set. If not body exists, returns null::
4545

46-
echo $message->body();
46+
echo $message->getBody();
4747

48-
.. php:method:: setBody([$data])
48+
.. php:method:: setBody($data)
4949
5050
:param mixed $data: The body of the message.
5151
:returns: the Message|Response instance to allow methods to be chained together.
5252
:rtype: CodeIgniter\\HTTP\\Message|CodeIgniter\\HTTP\\Response
5353

5454
Sets the body of the current request.
5555

56+
.. php:method:: appendBody($data)
57+
58+
:param mixed $data: The body of the message.
59+
:returns: the Message|Response instance to allow methods to be chained together.
60+
:rtype: CodeIgniter\\HTTP\\Message|CodeIgniter\\HTTP\\Response
61+
62+
Appends data to the body of the current request.
63+
5664
.. php:method:: populateHeaders()
5765
5866
:returns: void
@@ -73,7 +81,7 @@ Class Reference
7381

7482
Returns an array of all headers found or previously set.
7583

76-
.. php:method:: getHeader([$name])
84+
.. php:method:: getHeader($name)
7785
7886
:param string $name: The name of the header you want to retrieve the value of.
7987
:returns: Returns a single header object. If multiple headers with the same name exist, then will return an array of header objects.
@@ -112,7 +120,7 @@ Class Reference
112120

113121
$message->getHeader('Document-URI', FILTER_SANITIZE_URL);
114122

115-
.. php:method:: hasHeader([$name])
123+
.. php:method:: hasHeader($name)
116124
117125
:param string $name: The name of the header you want to see if it exists.
118126
:returns: Returns TRUE if it exists, FALSE otherwise.
@@ -132,7 +140,7 @@ Class Reference
132140
// Outputs:
133141
en, en-US
134142

135-
.. php:method:: setHeader([$name[, $value]])
143+
.. php:method:: setHeader($name, $value)
136144
137145
:param string $name: The name of the header to set the value for.
138146
:param mixed $value: The value to set the header to.
@@ -145,17 +153,17 @@ Class Reference
145153

146154
$message->setHeader('Host', 'codeigniter.com');
147155

148-
.. php:method:: removeHeader([$name])
156+
.. php:method:: removeHeader($name)
149157
150158
:param string $name: The name of the header to remove.
151159
:returns: The current message instance
152160
:rtype: CodeIgniter\\HTTP\\Message
153161

154162
Removes the header from the Message. ``$name`` is the case-insensitive name of the header::
155163

156-
$message->remove('Host');
164+
$message->removeHeader('Host');
157165

158-
.. php:method:: appendHeader([$name[, $value]]))
166+
.. php:method:: appendHeader($name, $value)
159167
160168
:param string $name: The name of the header to modify
161169
:param string $value: The value to add to the header.
@@ -168,7 +176,7 @@ Class Reference
168176

169177
$message->appendHeader('Accept-Language', 'en-US; q=0.8');
170178

171-
.. php:method:: prependHeader([$name[, $value]]))
179+
.. php:method:: prependHeader($name, $value)
172180
173181
:param string $name: The name of the header to modify
174182
:param string $value: The value to prepend to the header.

0 commit comments

Comments
 (0)