CRM-18231 - Cleanup environment example in civicrm.settings.php.template
#10972
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…example The expression `CRM_Core_BAO_Setting::DEVELOPER_PREFERENCES_NAME` does not work within `civicrm.settings.php` because the classloader has not been initialized yet. This file is just supposed to store the data needed for bootstrap.
When using the example snippets in the settings file, it's easy to accidentally leave `global $civicrm_setting` commented out -- which is fairly confusing/mysterious way to have your settings ignored. There's no cost to declaring `global $civicrm_setting` by default in new config files.
seamuslee001
approved these changes
Sep 11, 2017
| // $civicrm_setting[CRM_Core_BAO_Setting::DEVELOPER_PREFERENCES_NAME]['environment'] = 'Production'; | ||
| * via the browser. | ||
| */ | ||
| // $civicrm_setting['domain']['environment'] = 'Production'; |
There was a problem hiding this comment.
@totten isn't it 'Developer'? Not domain?
There was a problem hiding this comment.
If you want the verbose/legacy style, then you'd need to lookup the exact group name. In this case, it would be Developer Preferences.
In 4.7.0+, all those things are just aliases for domain: https://docs.civicrm.org/dev/en/master/api/changes/#470-global-civicrm_setting-multiple-changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Update the
environmentexample incivicrm.settings.php.template.Before
environment, it crashes -- because class-constants don't make sense in this context.global $civicrm_settingdeclaration.After
environment, it works.Technical Details
To test this, I would iteratively edit the config file and then run
Ping @seamuslee001 @monishdeb @eileenmcnaughton .