Skip to content

docs: Correcting documentation mistakes in upgrading from one version to another #7191

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 3 commits into from
Jan 28, 2023
Merged

docs: Correcting documentation mistakes in upgrading from one version to another #7191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c9e5d6
Update upgrade_405.rst
objecttothis Jan 27, 2023
73d2354
Update upgrade_412.rst
objecttothis Jan 27, 2023
a3a6dae
Update upgrade_431.rst
objecttothis Jan 27, 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
2 changes: 1 addition & 1 deletion user_guide_src/source/installation/upgrade_405.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Additional related deprecations from the HTTP layer:

* ``Message::isJSON()``: Check the "Content-Type" header directly
* ``Request[Interface]::isValidIP()``: Use the Validation class with ``valid_ip``
* ``Request[Interface]::getMethod()``: The ``$upper`` parameter will be removed, use str_to_upper()
* ``Request[Interface]::getMethod()``: The ``$upper`` parameter will be removed, use strtoupper()
* ``Request[Trait]::$ipAddress``: This property will become private
* ``Request::$proxyIPs``: This property will be removed; access ``config('App')->proxyIPs`` directly
* ``Request::__construct()``: The constructor will no longer take ``Config\App`` and has been made nullable to aid transition
Expand Down
2 changes: 1 addition & 1 deletion user_guide_src/source/installation/upgrade_412.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ BaseConnection::query() Return Values
``BaseConnection::query()`` method in prior versions was incorrectly returning BaseResult objects
even if the query failed. This method will now return ``false`` for failed queries (or throw an
Exception if ``DBDebug`` is ``true``) and will return booleans for write-type queries. Review any use
of ``query()`` method and be assess whether the value might be boolean instead of Result object.
of ``query()`` method and assess whether the value might be boolean instead of Result object.
For a better idea of what queries are write-type queries, check ``BaseConnection::isWriteType()``
and any DBMS-specific override ``isWriteType()`` in the relevant Connection class.

Expand Down
2 changes: 1 addition & 1 deletion user_guide_src/source/installation/upgrade_431.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ and it is recommended that you merge the updated versions with your application:
Config
------

- app/Config/Encryption.php
- app/Config/Email.php
- Set the default value ``''`` to ``$fromEmail``, ``$fromName``,
``$recipients``, ``$SMTPHost``, ``$SMTPUser`` and ``$SMTPPass``
to apply environment variable (**.env**) values.
Expand Down