Merge pull request #8563 from kenjis/docs-about-config-classes

docs: add "What are Configuration Classes?"
This commit is contained in:
kenjis 2024-03-18 10:36:26 +09:00 committed by GitHub
commit b8adef607e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 19 additions and 0 deletions

View File

@ -15,6 +15,23 @@ the application configuration files in the **app/Config** folder.
:local:
:depth: 2
What are Configuration Classes?
*******************************
Configuration classes are utilized to define system default configuration values.
System configuration values are typically *static*. Configuration classes are
intended to retain the settings that configure how the application operates,
rather than responding to each user's individual settings.
It is not recommended to alter values set during the instantiation of a
configuration class later during execution. In other words, it is recommended to
treat configuration classes as immutable or readonly classes. This is especially
important if you utilize :ref:`factories-config-caching`.
Configuration values can be hard-coded in the class files or obtained from
environment variables at instantiation.
Working with Configuration Files
********************************

View File

@ -29,6 +29,8 @@ Among the many features, it includes:
* Per-user permission overrides,
* and more...
.. _settings:
********
Settings
********