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: improve localization.rst #7468

Merged
merged 6 commits into from
Apr 29, 2023
Merged

docs: improve localization.rst #7468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8ac0d33
docs: add comment
kenjis Apr 29, 2023
4689e3f
docs: make depth 3
kenjis Apr 29, 2023
ab7f942
docs: add "Setting the Locale" section
kenjis Apr 29, 2023
b25726d
docs: decorate variable
kenjis Apr 29, 2023
dc5bf05
docs: change section title
kenjis Apr 29, 2023
c52050e
docs: change sentence to note
kenjis Apr 29, 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: 2 additions & 0 deletions app/Config/App.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ class App extends BaseConfig
* by the application in descending order of priority. If no match is
* found, the first locale will be used.
*
* IncomingRequest::setLocale() also uses this list.
*
* @var string[]
*/
public array $supportedLocales = ['en'];
Expand Down
23 changes: 20 additions & 3 deletions user_guide_src/source/outgoing/localization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Localization

.. contents::
:local:
:depth: 2
:depth: 3

********************
Working With Locales
Expand All @@ -30,6 +30,11 @@ supported language::
Configuring the Locale
======================

.. _setting-the-default-locale:

Setting the Default Locale
--------------------------

Every site will have a default language/locale they operate in. This can be set in **app/Config/App.php**:

.. literalinclude:: localization/001.php
Expand All @@ -52,7 +57,7 @@ method that will automatically perform :doc:`content negotiation </incoming/cont
determine the correct locale to use. The second method allows you to specify a segment in your routes that
will be used to set the locale.

Should you ever need to set the locale directly you may use ``IncomingRequest::setLocale(string $locale)``.
Should you ever need to set the locale directly, see `Setting the Current Locale`_.

Content Negotiation
-------------------
Expand All @@ -64,7 +69,7 @@ The first value tells the Request class that we do want to negotiate a locale, s

Once this is enabled, the system will automatically negotiate the correct language based upon an array
of locales that you have defined in ``$supportLocales``. If no match is found between the languages
that you support, and the requested language, the first item in $supportedLocales will be used. In
that you support, and the requested language, the first item in ``$supportedLocales`` will be used. In
the following example, the ``en`` locale would be used if no match is found:

.. literalinclude:: localization/003.php
Expand All @@ -91,6 +96,18 @@ file:

.. note:: The ``useSupportedLocalesOnly()`` method can be used since v4.3.0.

Setting the Current Locale
==========================

If you want to set the locale directly, you may use
``IncomingRequest::setLocale(string $locale)``.
You must set supported locales in **app/Config/App.php**:

.. literalinclude:: localization/003.php

.. note:: Any attempt to set a locale not included in this array will result in
the :ref:`default locale <setting-the-default-locale>` being set.

Retrieving the Current Locale
=============================

Expand Down