Use consistent terminology (preference versus setting)

7 files changed, 39 insertions, 38 deletions

diff --git a/library/WT/Auth.php b/library/WT/Auth.php
index ee4a7ae9d7..066cc1dbfa 100644
--- a/library/WT/Auth.php
+++ b/library/WT/Auth.php
@@ -46,7 +46,7 @@ class Auth {
 			$user = self::user();
 		}
 
-		return $user && $user->getSetting('canadmin') === '1';
+		return $user && $user->getPreference('canadmin') === '1';
 	}
 
 	/**
diff --git a/library/WT/GedcomRecord.php b/library/WT/GedcomRecord.php
index c83f21cc94..63b1085ff8 100644
--- a/library/WT/GedcomRecord.php
+++ b/library/WT/GedcomRecord.php
@@ -927,7 +927,7 @@ class WT_GedcomRecord {
 
 			$this->pending = $new_gedcom;
 
-			if (Auth::user()->getSetting('auto_accept')) {
+			if (Auth::user()->getPreference('auto_accept')) {
 				accept_all_changes($this->xref, $this->gedcom_id);
 				$this->gedcom  = $new_gedcom;
 				$this->pending = null;
@@ -970,7 +970,7 @@ class WT_GedcomRecord {
 		));
 
 		// Accept this pending change
-		if (Auth::user()->getSetting('auto_accept')) {
+		if (Auth::user()->getPreference('auto_accept')) {
 			accept_all_changes($xref, $gedcom_id);
 		}
 
@@ -1009,7 +1009,7 @@ class WT_GedcomRecord {
 		$this->pending = $gedcom;
 
 		// Accept this pending change
-		if (Auth::user()->getSetting('auto_accept')) {
+		if (Auth::user()->getPreference('auto_accept')) {
 			accept_all_changes($this->xref, $this->gedcom_id);
 			$this->gedcom  = $gedcom;
 			$this->pending = null;
@@ -1032,7 +1032,7 @@ class WT_GedcomRecord {
 		));
 
 		// Accept this pending change
-		if (Auth::user()->getSetting('auto_accept')) {
+		if (Auth::user()->getPreference('auto_accept')) {
 			accept_all_changes($this->xref, $this->gedcom_id);
 		}
 
diff --git a/library/WT/I18N.php b/library/WT/I18N.php
index fd85687a11..70bef97591 100644
--- a/library/WT/I18N.php
+++ b/library/WT/I18N.php
@@ -134,7 +134,7 @@ class WT_I18N {
 			if ($locale && array_key_exists($locale, $installed_languages)) {
 				// Requested in the URL?
 				if (Auth::id()) {
-					Auth::user()->setSetting('language', $locale);
+					Auth::user()->setPreference('language', $locale);
 				}
 			} elseif (array_key_exists($WT_SESSION->locale, $installed_languages)) {
 				// Rembered from a previous visit?
diff --git a/library/WT/MenuBar.php b/library/WT/MenuBar.php
index 276c85d32d..fd44889f86 100644
--- a/library/WT/MenuBar.php
+++ b/library/WT/MenuBar.php
@@ -57,7 +57,7 @@ class WT_MenuBar {
 		$submenu = new WT_Menu(WT_I18N::translate('My page'), 'index.php?ctype=user&ged='.WT_GEDURL, 'menu-mypage');
 		$menu->addSubmenu($submenu);
 		//-- editaccount submenu
-		if (Auth::user()->getSetting('editaccount')) {
+		if (Auth::user()->getPreference('editaccount')) {
 			$submenu = new WT_Menu(WT_I18N::translate('My account'), 'edituser.php', 'menu-myaccount');
 			$menu->addSubmenu($submenu);
 		}
diff --git a/library/WT/Stats.php b/library/WT/Stats.php
index 0983091f7c..fa1693ddbd 100644
--- a/library/WT/Stats.php
+++ b/library/WT/Stats.php
@@ -4281,7 +4281,7 @@ class WT_Stats {
 		$NumAnonymous = 0;
 		$loggedusers = array();
 		foreach (User::allLoggedIn() as $user) {
-			if (Auth::isAdmin() || $user->getSetting('visibleonline')) {
+			if (Auth::isAdmin() || $user->getPreference('visibleonline')) {
 				$loggedusers[] = $user;
 			} else {
 				$NumAnonymous++;
@@ -4312,11 +4312,11 @@ class WT_Stats {
 		if (Auth::check()) {
 			foreach ($loggedusers as $user) {
 				if ($type == 'list') {
-					$content .= "<li>" . WT_Filter::escapeHtml($user->getRealName()) . ' - ' . WT_Filter::escapeHtml($user->getUserName());
+					$content .= '<li>' . WT_Filter::escapeHtml($user->getRealName()) . ' - ' . WT_Filter::escapeHtml($user->getUserName());
 				} else {
 					$content .= WT_Filter::escapeHtml($user->getRealName()) . ' - ' . WT_Filter::escapeHtml($user->getUserName());
 				}
-				if (WT_USER_ID != $user->getUserId() && $user->getSetting('contactmethod') != 'none') {
+				if (WT_USER_ID != $user->getUserId() && $user->getPreference('contactmethod') != 'none') {
 					if ($type == 'list') {
 						$content .= '<br><a class="icon-email" href="#" onclick="return message(\'' . $user->getUserId() . '\', \'\', \'' . WT_Filter::escapeJs(get_query_url()) . '\');" title="' . WT_I18N::translate('Send message') . '"></a>';
 					} else {
@@ -4338,7 +4338,7 @@ class WT_Stats {
 		$anon = 0;
 		$visible = 0;
 		foreach (User::allLoggedIn() as $user) {
-			if (Auth::isAdmin() || $user->getSetting('visibleonline')) {
+			if (Auth::isAdmin() || $user->getPreference('visibleonline')) {
 				$visible++;
 			} else {
 				$anon++;
@@ -4418,14 +4418,14 @@ class WT_Stats {
 			} else {
 				$datestamp = $DATE_FORMAT;
 			}
-			return timestamp_to_gedcom_date($user->getSetting('reg_timestamp'))->Display(false, $datestamp);
+			return timestamp_to_gedcom_date($user->getPreference('reg_timestamp'))->Display(false, $datestamp);
 		case 'regtime':
 			if (is_array($params) && isset($params[0]) && $params[0] != '') {
 				$datestamp = $params[0];
 			} else {
 				$datestamp = str_replace('%', '', $TIME_FORMAT);
 			}
-			return date($datestamp, $user->getSetting('reg_timestamp'));
+			return date($datestamp, $user->getPreference('reg_timestamp'));
 		case 'loggedin':
 			if (is_array($params) && isset($params[0]) && $params[0] != '') {
 				$yes = $params[0];
diff --git a/library/WT/Tree.php b/library/WT/Tree.php
index c38fb5b83c..ae4e71b811 100644
--- a/library/WT/Tree.php
+++ b/library/WT/Tree.php
@@ -36,10 +36,10 @@ class WT_Tree {
 	private static $trees;
 
 	/** @var string[] Cached copy of the wt_gedcom_setting table. */
-	private $preference;
+	private $preferences;
 
 	/** @var string[][] Cached copy of the wt_user_gedcom_setting table. */
-	private $user_preference = array();
+	private $user_preferences = array();
 
 	// Create a tree object.  This is a private constructor - it can only
 	// be called from WT_Tree::getAll() to ensure proper initialisation.
@@ -66,14 +66,14 @@ class WT_Tree {
 	 * @return string|null
 	 */
 	public function getPreference($setting_name, $default = null) {
-		if ($this->preference === null) {
-			$this->preference = WT_DB::prepare(
+		if ($this->preferences === null) {
+			$this->preferences = WT_DB::prepare(
 				"SELECT SQL_CACHE setting_name, setting_value FROM `##gedcom_setting` WHERE gedcom_id = ?"
 			)->execute(array($this->tree_id))->fetchAssoc();
 		}
 
-		if (array_key_exists($setting_name, $this->preference)) {
-			return $this->preference[$setting_name];
+		if (array_key_exists($setting_name, $this->preferences)) {
+			return $this->preferences[$setting_name];
 		} else {
 			return $default;
 		}
@@ -94,7 +94,7 @@ class WT_Tree {
 				"REPLACE INTO `##gedcom_setting` (gedcom_id, setting_name, setting_value) VALUES (?, ?, LEFT(?, 255))"
 			)->execute(array($this->tree_id, $setting_name, $setting_value));
 			// Update our cache
-			$this->preference[$setting_name] = $setting_value;
+			$this->preferences[$setting_name] = $setting_value;
 			// Audit log of changes
 			Log::addConfigurationLog('Tree setting "' . $setting_name . '" set to "' . $setting_value . '"');
 		}
@@ -114,14 +114,14 @@ class WT_Tree {
 	public function getUserPreference($user, $setting_name, $default = null) {
 		// There are lots of settings, and we need to fetch lots of them on every page
 		// so it is quicker to fetch them all in one go.
-		if (!array_key_exists($user->getUserId(), $this->user_preference)) {
-			$this->user_preference[$user->getUserId()] = WT_DB::prepare(
+		if (!array_key_exists($user->getUserId(), $this->user_preferences)) {
+			$this->user_preferences[$user->getUserId()] = WT_DB::prepare(
 				"SELECT SQL_CACHE setting_name, setting_value FROM `##user_gedcom_setting` WHERE user_id = ? AND gedcom_id = ?"
 			)->execute(array($user->getUserId(), $this->tree_id))->fetchAssoc();
 		}
 
-		if (array_key_exists($setting_name, $this->user_preference[$user->getUserId()])) {
-			return $this->user_preference[$user->getUserId()][$setting_name];
+		if (array_key_exists($setting_name, $this->user_preferences[$user->getUserId()])) {
+			return $this->user_preferences[$user->getUserId()][$setting_name];
 		} else {
 			return $default;
 		}
@@ -143,7 +143,7 @@ class WT_Tree {
 				"REPLACE INTO `##user_gedcom_setting` (user_id, gedcom_id, setting_name, setting_value) VALUES (?, ?, ?, LEFT(?, 255))"
 			)->execute(array($user->getUserId(), $this->tree_id, $setting_name, $setting_value));
 			// Update our cache
-			$this->user_preference[$user->getUserId()][$setting_name] = $setting_value;
+			$this->user_preferences[$user->getUserId()][$setting_name] = $setting_value;
 			// Audit log of changes
 			Log::addConfigurationLog('Tree setting "' . $setting_name . '" set to "' . $setting_value . '" for user "' . $user->getUserName() . '"');
 		}
diff --git a/library/WT/User.php b/library/WT/User.php
index e58dcfcd5a..594db4a893 100644
--- a/library/WT/User.php
+++ b/library/WT/User.php
@@ -35,8 +35,8 @@ class User {
 	/** @var  string The email address of this user. */
 	private $email;
 
-	/** @var array Settings for the user, from the wt_user_setting table. */
-	private $settings;
+	/** @var array Cached copy of the wt_user_setting table. */
+	private $preferences;
 
 	/** @var  User[] Only fetch users from the database once. */
 	private static $cache = array();
@@ -378,19 +378,20 @@ class User {
 	 *
 	 * @return string|null
 	 */
-	public function getSetting($setting_name, $default = null) {
-		if ($this->settings === null) {
-			if ($this->getUserId()) {
-				$this->settings = WT_DB::prepare(
+	public function getPreference($setting_name, $default = null) {
+		if ($this->preferences === null) {
+			if ($this->user_id) {
+				$this->preferences = WT_DB::prepare(
 					"SELECT SQL_CACHE setting_name, setting_value FROM `##user_setting` WHERE user_id = ?"
 				)->execute(array($this->user_id))->fetchAssoc();
 			} else {
-				$this->settings = array();
+				// Not logged in?  We have no preferences.
+				$this->preferences = array();
 			}
 		}
 
-		if (array_key_exists($setting_name, $this->settings)) {
-			return $this->settings[$setting_name];
+		if (array_key_exists($setting_name, $this->preferences)) {
+			return $this->preferences[$setting_name];
 		} else {
 			return $default;
 		}
@@ -404,15 +405,15 @@ class User {
 	 *
 	 * @return User
 	 */
-	public function setSetting($setting_name, $setting_value) {
+	public function setPreference($setting_name, $setting_value) {
 		if ($setting_value === null) {
 			WT_DB::prepare("DELETE FROM `##user_setting` WHERE user_id=? AND setting_name=?")
 				->execute(array($this->user_id, $setting_name));
-			unset($this->settings[$setting_name]);
-		} elseif ($this->getsetting($setting_name) !== $setting_value) {
+			unset($this->preferences[$setting_name]);
+		} elseif ($this->getPreference($setting_name) !== $setting_value) {
 			WT_DB::prepare("REPLACE INTO `##user_setting` (user_id, setting_name, setting_value) VALUES (?, ?, LEFT(?, 255))")
 				->execute(array($this->user_id, $setting_name, $setting_value));
-			$this->settings[$setting_name] = $setting_value;
+			$this->preferences[$setting_name] = $setting_value;
 		}
 
 		return $this;