Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix user guide for Message class #2282

Merged
merged 1 commit into from
Sep 28, 2019
Merged

Fix user guide for Message class #2282

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions user_guide_src/source/incoming/message.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,14 @@ Class Reference
The preceding ``HTTP_`` is removed from the string. So ``HTTP_ACCEPT_LANGUAGE`` becomes
``Accept-Language``.

.. php:method:: headers()
.. php:method:: getHeaders()

:returns: An array of all of the headers found.
:rtype: array

Returns an array of all headers found or previously set.

.. php:method:: header([$name[, $filter = null]])
.. php:method:: getHeader([$name[, $filter = null]])

:param string $name: The name of the header you want to retrieve the value of.
:param int $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
Expand All @@ -84,14 +84,14 @@ Class Reference
While the header is converted internally as described above, you can access the header with any type of case::

// These are all the same:
$message->header('HOST');
$message->header('Host');
$message->header('host');
$message->getHeader('HOST');
$message->getHeader('Host');
$message->getHeader('host');

If the header has multiple values, the values will return as an array of values. You can use the ``headerLine()``
method to retrieve the values as a string::

echo $message->header('Accept-Language');
echo $message->getHeader('Accept-Language');

// Outputs something like:
[
Expand All @@ -101,7 +101,7 @@ Class Reference

You can filter the header by passing a filter value in as the second parameter::

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

.. php:method:: headerLine($name)

Expand Down