From 496f6c63edd6be7004aec8fee541ad302b6aad8a Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 26 Feb 2020 16:12:10 -0800 Subject: [PATCH] civicrm.settings.php.template - Simplify examples of `$civicrm_setting` Overview -------- This simplifies the examples in `civicrm.settings.php.template`. Before ------ Every reference to `$civicrm_setting` uses an English-looking group-name like ``php $civicrm_setting['URL Preferences']['imageUploadURL'] = 'http://example.com/example-image-upload-url'; ``` After ----- The varying group names are just `domain`. ```php $civicrm_setting['domain']['imageUploadURL'] = 'http://example.com/example-image-upload-url';. ``` Comments -------- Since CiviCRM v4.7, expessions like `$civicrm_setting['URL Preferences']` have been aliases for `$civicrm_setting['domain']`. (See `SettingsManager::parseMandatorySettings()`.) These examples were initially kept in the verbose 4.6 format so that users of 4.6 and 4.7 could continue to exchange examples with each other. But 4.6 and 4.7 are pretty old, so I don't think that's an issue anymore. We're now firmly in the 5.x world. What does still matter is intuition - if the examples set an expectation that you should put things under buckets like `URL Preferences`, then it implies that you should be thinking about those buckets. (Does the `extensionsURL` belong under `URL Preferences` or `Extension Preferences`? Should a search-related setting defined by an extension go under `Search Preferences` or `Extension Preferences`? Can I make up new groups? If I know the name used by the Setting API, then how do I figure out the group-name used for the `$civicrm_setting` override? ... The answer to all of these questions is that it doesn't matter because they're really the same group.) --- .../CRM/common/civicrm.settings.php.template | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/templates/CRM/common/civicrm.settings.php.template b/templates/CRM/common/civicrm.settings.php.template index d00db87015..a89b04864a 100644 --- a/templates/CRM/common/civicrm.settings.php.template +++ b/templates/CRM/common/civicrm.settings.php.template @@ -241,43 +241,43 @@ if (!defined('CIVICRM_UF_BASEURL')) { */ // Override the Temporary Files directory. - // $civicrm_setting['Directory Preferences']['uploadDir'] = '/path/to/upload-dir' ; + // $civicrm_setting['domain']['uploadDir'] = '/path/to/upload-dir' ; // Override the custom files upload directory. - // $civicrm_setting['Directory Preferences']['customFileUploadDir'] = '/path/to/custom-dir'; + // $civicrm_setting['domain']['customFileUploadDir'] = '/path/to/custom-dir'; // Override the images directory. - // $civicrm_setting['Directory Preferences']['imageUploadDir'] = '/path/to/image-upload-dir' ; + // $civicrm_setting['domain']['imageUploadDir'] = '/path/to/image-upload-dir' ; // Override the custom templates directory. - // $civicrm_setting['Directory Preferences']['customTemplateDir'] = '/path/to/template-dir'; + // $civicrm_setting['domain']['customTemplateDir'] = '/path/to/template-dir'; // Override the Custom php path directory. - // $civicrm_setting['Directory Preferences']['customPHPPathDir'] = '/path/to/custom-php-dir'; + // $civicrm_setting['domain']['customPHPPathDir'] = '/path/to/custom-php-dir'; // Override the extensions directory. - // $civicrm_setting['Directory Preferences']['extensionsDir'] = '/path/to/extensions-dir'; + // $civicrm_setting['domain']['extensionsDir'] = '/path/to/extensions-dir'; // Override the resource url - // $civicrm_setting['URL Preferences']['userFrameworkResourceURL'] = 'http://example.com/example-resource-url/'; + // $civicrm_setting['domain']['userFrameworkResourceURL'] = 'http://example.com/example-resource-url/'; // Override the Image Upload URL (System Settings > Resource URLs) - // $civicrm_setting['URL Preferences']['imageUploadURL'] = 'http://example.com/example-image-upload-url'; + // $civicrm_setting['domain']['imageUploadURL'] = 'http://example.com/example-image-upload-url'; // Override the Custom CiviCRM CSS URL - // $civicrm_setting['URL Preferences']['customCSSURL'] = 'http://example.com/example-css-url' ; + // $civicrm_setting['domain']['customCSSURL'] = 'http://example.com/example-css-url' ; // Override the extensions resource URL - // $civicrm_setting['URL Preferences']['extensionsURL'] = 'http://example.com/pathtoextensiondir' + // $civicrm_setting['domain']['extensionsURL'] = 'http://example.com/pathtoextensiondir' // Disable display of Community Messages on home dashboard - // $civicrm_setting['CiviCRM Preferences']['communityMessagesUrl'] = false; + // $civicrm_setting['domain']['communityMessagesUrl'] = false; // Disable automatic download / installation of extensions - // $civicrm_setting['Extension Preferences']['ext_repo_url'] = false; + // $civicrm_setting['domain']['ext_repo_url'] = false; // set triggers to be managed offline per CRM-18212 - // $civicrm_setting['CiviCRM Preferences']['logging_no_trigger_permission'] = 1; + // $civicrm_setting['domain']['logging_no_trigger_permission'] = 1; // Override the CMS root path defined by cmsRootPath. // define('CIVICRM_CMSDIR', '/path/to/install/root/'); @@ -287,7 +287,7 @@ if (!defined('CIVICRM_UF_BASEURL')) { // "asks": requests for donations or membership signup/renewal to CiviCRM // "releases": major release announcements // "events": announcements of local/national upcoming events - // $civicrm_setting['CiviCRM Preferences']['communityMessagesUrl'] = 'https://alert.civicrm.org/alert?prot=1&ver={ver}&uf={uf}&sid={sid}&lang={lang}&co={co}&optout=offers,asks'; + // $civicrm_setting['domain']['communityMessagesUrl'] = 'https://alert.civicrm.org/alert?prot=1&ver={ver}&uf={uf}&sid={sid}&lang={lang}&co={co}&optout=offers,asks'; /** -- 2.25.1