Skip to content

Add docs for casting functions #7793

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

Merged
merged 2 commits into from
Jan 9, 2024
Merged

Add docs for casting functions #7793

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
58ccfad
Add docs for casting functions
markstory Jan 7, 2024
73b168c
Update en/appendices/5-1-upgrade-guide.rst
markstory Jan 9, 2024
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
6 changes: 6 additions & 0 deletions en/appendices/5-1-upgrade-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ Console

- ``Arguments::getBooleanOption()`` and ``Arguments::getMultipleOption()`` were added.

Core
----

- The ``toString``, ``toInt``, ``toBool`` functions were added. They give you
a typesafe way to cast request data or other input and return ``null`` when conversion fails.

Http
----

Expand Down
19 changes: 19 additions & 0 deletions en/controllers/request-response.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,25 @@ If you want to access all the query parameters you can use

$query = $this->request->getQueryParams();

You can use the casting utility functions to provide typesafe access to request
data and other input::

use function Cake\Core\toBool;
use function Cake\Core\toInt;
use function Cake\Core\toString;

// $active is bool|null.
$active = toBool($this->request->getQuery('active'));

// $page is int|null.
$page = toInt($this->request->getQuery('page'));

// $query is string|null.
$query = toString($this->request->getQuery('query'));

.. versionadded:: 5.1.0
Casting functions were added.

Request Body Data
-----------------

Expand Down