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

docs: add warning to getVar() #8160

Merged
merged 2 commits into from
Nov 7, 2023
Merged

docs: add warning to getVar() #8160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6293b6b
docs: add warning to getVar() in validation.rst
kenjis Nov 6, 2023
1149f27
docs: add warning to getVar() in incomingrequest.rst
kenjis Nov 6, 2023
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
5 changes: 5 additions & 0 deletions user_guide_src/source/incoming/incomingrequest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ Getting Data

The ``getVar()`` method will pull from ``$_REQUEST``, so will return any data from ``$_GET``, ``$POST``, or ``$_COOKIE`` (depending on php.ini `request-order <https://www.php.net/manual/en/ini.core.php#ini.request-order>`_).

.. warning:: If you want to validate POST data only, don't use ``getVar()``.
Newer values override older values. POST values may be overridden by the
cookies if they have the same name, and you set "C" after "P" in
`request-order <https://www.php.net/manual/en/ini.core.php#ini.request-order>`_.

.. note:: If the incoming request has a ``Content-Type`` header set to ``application/json``,
the ``getVar()`` method returns the JSON data instead of ``$_REQUEST`` data.

Expand Down
7 changes: 7 additions & 0 deletions user_guide_src/source/libraries/validation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,13 @@ For example, data returned by multi select dropdown:
withRequest()
=============

.. warning:: If you want to validate POST data only, don't use ``withRequest()``.
This method uses :ref:`$request->getVar() <incomingrequest-getting-data>`
which returns ``$_GET``, ``$_POST`` or ``$_COOKIE`` data in that order
(depending on php.ini `request-order <https://www.php.net/manual/en/ini.core.php#ini.request-order>`_).
Newer values override older values. POST values may be overridden by the
cookies if they have the same name.

One of the most common times you will use the validation library is when validating
data that was input from an HTTP Request. If desired, you can pass an instance of the
current Request object and it will take all of the input data and set it as the
Expand Down