Skip to content

docs: add "What are Configuration Classes?" #8563

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.

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
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions user_guide_src/source/general/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
********************************

Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/libraries/official_packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Among the many features, it includes:
* Per-user permission overrides,
* and more...

.. _settings:

********
Settings
********
Expand Down