From 3a260ed6effe5b1db526a112de0969c9d8392ffb Mon Sep 17 00:00:00 2001
From: Sunil Pawar
Date: Thu, 26 Nov 2020 18:50:43 +0530
Subject: [PATCH] changed lable and field name from favourite to Pinned
---
CRM/Admin/Form/Setting/Localization.php | 2 +-
CRM/Core/BAO/Country.php | 32 +++++++++----------
settings/Localization.setting.php | 8 ++---
.../CRM/Admin/Form/Setting/Localization.hlp | 2 +-
.../CRM/Admin/Form/Setting/Localization.tpl | 6 ++--
5 files changed, 25 insertions(+), 25 deletions(-)
diff --git a/CRM/Admin/Form/Setting/Localization.php b/CRM/Admin/Form/Setting/Localization.php
index eec3334e2a..9dc3ae7c50 100644
--- a/CRM/Admin/Form/Setting/Localization.php
+++ b/CRM/Admin/Form/Setting/Localization.php
@@ -25,7 +25,7 @@ class CRM_Admin_Form_Setting_Localization extends CRM_Admin_Form_Setting {
'countryLimit' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
'customTranslateFunction' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
'defaultContactCountry' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
- 'favouriteContactCountries' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
+ 'pinnedContactCountries' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
'defaultContactStateProvince' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
'defaultCurrency' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
'fieldSeparator' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
diff --git a/CRM/Core/BAO/Country.php b/CRM/Core/BAO/Country.php
index 2c32a578cd..159959780c 100644
--- a/CRM/Core/BAO/Country.php
+++ b/CRM/Core/BAO/Country.php
@@ -95,30 +95,30 @@ class CRM_Core_BAO_Country extends CRM_Core_DAO_Country {
}
/**
- * Provide list of favourite contries.
+ * Provide list of Pinned countries.
*
* @param $availableCountries
* @return array
*/
- public static function favouriteContactCountries($availableCountries) {
- static $cachedFavouriteContactCountries = [];
- $favouriteContactCountries = Civi::settings()->get('favouriteContactCountries');
+ public static function pinnedContactCountries($availableCountries) {
+ static $cachedPinnedContactCountries = [];
+ $pinnedContactCountries = Civi::settings()->get('pinnedContactCountries');
- if (!empty($favouriteContactCountries) && !$cachedFavouriteContactCountries) {
- $favouriteCountries = [];
- foreach($favouriteContactCountries as $favouriteContactCountry) {
- if (array_key_exists($favouriteContactCountry, $availableCountries)) {
- $favouriteCountries[$favouriteContactCountry] = $availableCountries[$favouriteContactCountry];
+ if (!empty($pinnedContactCountries) && !$cachedPinnedContactCountries) {
+ $pinnedCountries = [];
+ foreach($pinnedContactCountries as $pinnedContactCountry) {
+ if (array_key_exists($pinnedContactCountry, $availableCountries)) {
+ $pinnedCountries[$pinnedContactCountry] = $availableCountries[$pinnedContactCountry];
}
}
- $cachedFavouriteContactCountries = $favouriteCountries;
+ $cachedPinnedContactCountries = $pinnedCountries;
}
- return $cachedFavouriteContactCountries;
+ return $cachedPinnedContactCountries;
}
/**
* Provide sorted list of countries with default country with first position
- * then favourite countries then rest of countries.
+ * then Pinned countries then rest of countries.
*
* @param $availableCountries
* @return array
@@ -133,7 +133,7 @@ class CRM_Core_BAO_Country extends CRM_Core_DAO_Country {
]);
$availableCountries = CRM_Utils_Array::asort($availableCountries);
}
- $favouriteContactCountries = CRM_Core_BAO_Country::favouriteContactCountries($availableCountries);
+ $pinnedContactCountries = CRM_Core_BAO_Country::pinnedContactCountries($availableCountries);
// if default country is set, percolate it to the top
if ($defaultContactCountry = CRM_Core_BAO_Country::defaultContactCountry()) {
$countryIsoCodes = CRM_Core_PseudoConstant::countryIsoCode();
@@ -141,11 +141,11 @@ class CRM_Core_BAO_Country extends CRM_Core_DAO_Country {
if ($defaultID !== FALSE) {
$default = [];
$default[$defaultID] = $availableCountries[$defaultID] ?? NULL;
- $availableCountries = $default + $favouriteContactCountries + $availableCountries;
+ $availableCountries = $default + $pinnedContactCountries + $availableCountries;
}
}
- elseif (!empty($favouriteContactCountries)) {
- $availableCountries = $favouriteContactCountries + $availableCountries;
+ elseif (!empty($pinnedContactCountries)) {
+ $availableCountries = $pinnedContactCountries + $availableCountries;
}
return $availableCountries;
diff --git a/settings/Localization.setting.php b/settings/Localization.setting.php
index 20da0af84f..1dfe8b35a5 100644
--- a/settings/Localization.setting.php
+++ b/settings/Localization.setting.php
@@ -528,10 +528,10 @@ return [
'help_text' => 'If a contact is created with no language this setting will determine the language data (if any) to save.'
. 'You may or may not wish to make an assumption here about whether it matches the site language',
],
- 'favouriteContactCountries' => [
+ 'pinnedContactCountries' => [
'group_name' => 'Localization Preferences',
'group' => 'localization',
- 'name' => 'favouriteContactCountries',
+ 'name' => 'pinnedContactCountries',
'type' => 'Array',
'quick_form_type' => 'Element',
'html_type' => 'advmultiselect',
@@ -541,8 +541,8 @@ return [
'class' => 'advmultiselect',
],
'default' => [],
- 'add' => '5.31',
- 'title' => ts('Favourite Countries'),
+ 'add' => '5.33',
+ 'title' => ts('Pinned countries'),
'is_domain' => 1,
'is_contact' => 0,
'description' => ts('Appear in Top section of select list'),
diff --git a/templates/CRM/Admin/Form/Setting/Localization.hlp b/templates/CRM/Admin/Form/Setting/Localization.hlp
index 74bc8afb39..20b0a91031 100644
--- a/templates/CRM/Admin/Form/Setting/Localization.hlp
+++ b/templates/CRM/Admin/Form/Setting/Localization.hlp
@@ -65,7 +65,7 @@
{ts}State/province listings are populated dynamically based on the selected Country for all standard contact address editing forms, as well as for Profile forms which include both a Country and a State/Province field. This setting controls which countries' states and/or provinces are available in the State/Province selection field for Custom Fields or for Profile forms which do NOT include a Country field.{/ts}
{/htxt}
-{htxt id="favouriteContactCountries"}
+{htxt id="pinnedContactCountries"}
{ts}Selected countries will appear in top section of country list.{/ts}
diff --git a/templates/CRM/Admin/Form/Setting/Localization.tpl b/templates/CRM/Admin/Form/Setting/Localization.tpl
index 491aa1103a..9666278ac6 100644
--- a/templates/CRM/Admin/Form/Setting/Localization.tpl
+++ b/templates/CRM/Admin/Form/Setting/Localization.tpl
@@ -92,9 +92,9 @@
{$form.defaultContactCountry.label} {help id='defaultContactCountry' title=$form.defaultContactCountry.label} |
{$form.defaultContactCountry.html} |
-
- | {$form.favouriteContactCountries.label} {help id='favouriteContactCountries' title=$form.favouriteContactCountries.label} |
- {$form.favouriteContactCountries.html} |
+
+ | {$form.pinnedContactCountries.label} {help id='pinnedContactCountries' title=$form.pinnedContactCountries.label} |
+ {$form.pinnedContactCountries.html} |
| {$form.defaultContactStateProvince.label} {help id='defaultContactCountry' title=$form.defaultContactStateProvince.label} |
--
2.25.1