xref: /webtrees/app/Site.php (revision 369c0ce6d43eee62858778711fa4744ed347814a)
1a25f0a04SGreg Roach<?php
2a25f0a04SGreg Roach/**
3a25f0a04SGreg Roach * webtrees: online genealogy
4*369c0ce6SGreg Roach * Copyright (C) 2016 webtrees development team
5a25f0a04SGreg Roach * This program is free software: you can redistribute it and/or modify
6a25f0a04SGreg Roach * it under the terms of the GNU General Public License as published by
7a25f0a04SGreg Roach * the Free Software Foundation, either version 3 of the License, or
8a25f0a04SGreg Roach * (at your option) any later version.
9a25f0a04SGreg Roach * This program is distributed in the hope that it will be useful,
10a25f0a04SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
11a25f0a04SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12a25f0a04SGreg Roach * GNU General Public License for more details.
13a25f0a04SGreg Roach * You should have received a copy of the GNU General Public License
14a25f0a04SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
15a25f0a04SGreg Roach */
1676692c8bSGreg Roachnamespace Fisharebest\Webtrees;
17a25f0a04SGreg Roach
18a25f0a04SGreg Roach/**
1976692c8bSGreg Roach * Provide an interface to the wt_site_setting table.
20a25f0a04SGreg Roach */
21a25f0a04SGreg Roachclass Site {
22a25f0a04SGreg Roach	/**
23a25f0a04SGreg Roach	 * Everything from the wt_site_setting table.
24a25f0a04SGreg Roach	 *
25a25f0a04SGreg Roach	 * @var array
26a25f0a04SGreg Roach	 */
27c999a340SGreg Roach	private static $settings = null;
28a25f0a04SGreg Roach
29a25f0a04SGreg Roach	/**
30a25f0a04SGreg Roach	 * Get the site’s configuration settings
31a25f0a04SGreg Roach	 *
32a25f0a04SGreg Roach	 * @param string $setting_name
33a25f0a04SGreg Roach	 *
34a25f0a04SGreg Roach	 * @return string|null
35a25f0a04SGreg Roach	 */
36a25f0a04SGreg Roach	public static function getPreference($setting_name) {
37a25f0a04SGreg Roach		// There are lots of settings, and we need to fetch lots of them on every page
38a25f0a04SGreg Roach		// so it is quicker to fetch them all in one go.
39c999a340SGreg Roach		if (self::$settings === null) {
40c999a340SGreg Roach			self::$settings = Database::prepare(
41a25f0a04SGreg Roach				"SELECT SQL_CACHE setting_name, setting_value FROM `##site_setting`"
42a25f0a04SGreg Roach			)->fetchAssoc();
43a25f0a04SGreg Roach		}
44a25f0a04SGreg Roach
45a25f0a04SGreg Roach		// A setting that hasn't yet been set?
46c999a340SGreg Roach		if (!array_key_exists($setting_name, self::$settings)) {
47c999a340SGreg Roach			self::$settings[$setting_name] = null;
48a25f0a04SGreg Roach		}
49a25f0a04SGreg Roach
50c999a340SGreg Roach		return self::$settings[$setting_name];
51a25f0a04SGreg Roach	}
52a25f0a04SGreg Roach
53a25f0a04SGreg Roach	/**
54a25f0a04SGreg Roach	 * Set the site’s configuration settings.
55a25f0a04SGreg Roach	 *
56a25f0a04SGreg Roach	 * @param string          $setting_name
57a25f0a04SGreg Roach	 * @param string|int|bool $setting_value
58a25f0a04SGreg Roach	 */
59a25f0a04SGreg Roach	public static function setPreference($setting_name, $setting_value) {
60a25f0a04SGreg Roach		// Only need to update the database if the setting has actually changed.
61a25f0a04SGreg Roach		if (self::getPreference($setting_name) != $setting_value) {
62a25f0a04SGreg Roach			if ($setting_value === null) {
63a25f0a04SGreg Roach				Database::prepare(
64a25f0a04SGreg Roach					"DELETE FROM `##site_setting` WHERE setting_name = :setting_name"
65a25f0a04SGreg Roach				)->execute(array(
66cbc1590aSGreg Roach					'setting_name' => $setting_name,
67a25f0a04SGreg Roach				));
68a25f0a04SGreg Roach			} else {
69a25f0a04SGreg Roach				Database::prepare(
70a25f0a04SGreg Roach					"REPLACE INTO `##site_setting` (setting_name, setting_value)" .
71b6d24f4fSMichael Schramm					" VALUES (:setting_name, LEFT(:setting_value, 2000))"
72a25f0a04SGreg Roach				)->execute(array(
73a25f0a04SGreg Roach					'setting_name'  => $setting_name,
74a25f0a04SGreg Roach					'setting_value' => $setting_value,
75a25f0a04SGreg Roach				));
76a25f0a04SGreg Roach			}
77a25f0a04SGreg Roach
78c999a340SGreg Roach			self::$settings[$setting_name] = $setting_value;
79a25f0a04SGreg Roach
80a25f0a04SGreg Roach			Log::addConfigurationLog('Site setting "' . $setting_name . '" set to "' . $setting_value . '"');
81a25f0a04SGreg Roach		}
82a25f0a04SGreg Roach	}
83a25f0a04SGreg Roach}
84