-
Notifications
You must be signed in to change notification settings - Fork 1
/
SiteSettingUtil.php
315 lines (278 loc) · 7.96 KB
/
SiteSettingUtil.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<?php
/**
* SiteSetting Utility
*
* @author Noriko Arai <arai@nii.ac.jp>
* @author Shohei Nakajima <nakajimashouhei@gmail.com>
* @link http://www.netcommons.org NetCommons Project
* @license http://www.netcommons.org/license.txt NetCommons License
* @copyright Copyright 2014, NetCommons Project
*/
App::uses('CakeText', 'Utility');
App::uses('SiteSettingUtilFunc', 'SiteManager.Utility');
/**
* SiteSetting Utility
*
* サイトの設定として必要な情報を保持します。<br>
* [NetCommonsAppController::beforeFilter](../NetCommons/classes/NetCommonsAppController.html#method_beforeFilter)
* で初期処理が呼び出され、値が設定されます。<br>
* 値を取得する時は、[readメソッド](#method_read)を使用します。<br>
* 値を保持する時は、[writeメソッド](#method_write)を使用します。<br>
* 値を削除する時は、[removeメソッド](#method_remove)を使用します。<br>
*
* @author Shohei Nakajima <nakajimashouhei@gmail.com>
* @package NetCommons\SiteManager\Utility
*/
class SiteSettingUtil {
/**
* サイト設定のデータ保持用
*
* @var array
*/
protected static $_data = array();
/**
* 初期データをセットする
*
* [NetCommonsAppController::beforeFilter](../NetCommons/classes/NetCommonsAppController.html#method_beforeFilter)
* で処理を呼び出す。
*
* @return void
*/
public static function initialize() {
self::setup(array(
// * サイト名
'App.site_name',
// * システム標準使用言語
'Config.language',
// * 標準の開始ルーム
'App.default_start_room',
// * サイトタイムゾーン
'App.default_timezone',
// * グループルームの容量
'App.disk_for_group_room',
// * プライベートルームの容量
'App.disk_for_private_room',
// * デバッグモード
'debug',
//// * デフォルトテーマ
//'theme',
// * サイトの一時停止
// ** サイトを一時停止する
'App.close_site',
// * パスワード再発行
// ** パスワード再発行を使う
'ForgotPass.use_password_reissue',
// * 入会設定
// ** 自動会員登録を許可する
'AutoRegist.use_automatic_register',
// * セッション
'Session',
));
//テーマのみデフォルト値セット
if (! Hash::check(self::$_data, 'theme')) {
self::write('theme', 'Default', '0');
}
//下記は設定は、Configureにもwriteする
$siteSetting = array(
'Config.language',
'theme',
);
foreach ($siteSetting as $key) {
Configure::write($key, self::read($key));
}
//Sessionの設定値を変えるため、Configureにセットする
$session = Hash::merge(Configure::read('Session'), self::read('Session'));
Configure::write('Session', $session);
}
/**
* データをセットする
*
* @param array $keyPaths Hashクラスのpath
* @param bool $force 強制的に書き込むかどうか。falseの場合、既にあれば書き込みを行わない。
* @return void
* @SuppressWarnings(PHPMD.BooleanArgumentFlag)
*/
public static function setup($keyPaths, $force = false) {
$SiteSetting = ClassRegistry::init('SiteManager.SiteSetting');
if (is_string($keyPaths)) {
$keyPaths = array($keyPaths);
}
$conditions = array();
foreach ($keyPaths as $keyPath) {
if ($force || ! Hash::check(self::$_data, $keyPath)) {
$conditions[] = array(
'SiteSetting.key LIKE' => $keyPath . '%'
);
}
}
if (! $conditions) {
return;
}
$result = $SiteSetting->find('all', array(
'recursive' => -1,
'fields' => array(
'language_id', 'key', 'value'
),
'conditions' => array('OR' => $conditions)
));
foreach ($result as $siteSetting) {
self::write(
$siteSetting['SiteSetting']['key'],
$siteSetting['SiteSetting']['value'],
$siteSetting['SiteSetting']['language_id']
);
}
}
/**
* 指定された$keyの値を返します。
*
* サイト名(App.site_name)を取得したい場合
* ```
* SiteSetting::read('App.site_name');
* ```
*
* @param string|null $keyPath Hashクラスのpath
* @param mixed $default デフォルト値
* @param int $langId 言語ID(Language.id)
* @return array|null SiteSettingデータ
*/
public static function read($keyPath, $default = null, $langId = null) {
if (! isset($langId)) {
$langId = Current::read('Language.id', '0');
}
$pathes = array();
if (! is_array($keyPath)) {
$basePathes = self::_tokenize($keyPath);
} else {
$basePathes = $keyPath;
}
$pathes = $basePathes;
if (Hash::get(self::$_data, $pathes) === null) {
self::setup($keyPath);
}
if ($keyPath === 'Config.language' &&
Hash::get(self::$_data, $keyPath . '.' . '0') === '') {
return (new SiteSettingUtilFunc())->acceptLanguage();
}
$pathes = $basePathes;
$pathes[] = $langId;
if (Hash::get(self::$_data, $pathes)) {
return Hash::get(self::$_data, $pathes);
}
$pathes = $basePathes;
$pathes[] = '0';
if (Hash::get(self::$_data, $pathes)) {
return Hash::get(self::$_data, $pathes);
}
$pathes = $basePathes;
if (is_array(Hash::get(self::$_data, $pathes))) {
$valueArray = Hash::get(self::$_data, $pathes);
$result = array();
$result = (new SiteSettingUtilFunc())->getReadData($result, $valueArray, $default, $langId);
return $result;
}
return $default;
}
/**
* 指定された$keyの値をセットします
*
* サイト名(App.site_name)をセットしたい場合
* ```
* SiteSetting::write('App.site_name', 'NetCommons3', '2');
* ```
*
* @param string $keyPath Hashクラスのpath、nullの場合、Hash::mergeする
* @param mixed $value セットする値
* @param int $langId 言語ID(Language.id)
* @return void
*/
public static function write($keyPath, $value, $langId) {
//`$keyPath = 'App.site_name'; $value = 'aaaa';` を
//`$keyPath = 'App'; $value = array('site_name' => 'aaaa');` に変換する
if (strpos($keyPath, '.') !== false) {
$pathes = self::_tokenize($keyPath);
//配列の平坦化から多次元配列に変換
$keyPath = array_shift($pathes);
$valueArray = array();
$tmp =& $valueArray;
foreach ($pathes as $key) {
$tmp[$key] = array();
$tmp =& $tmp[$key];
}
$tmp = $value;
$value = $valueArray;
}
if (is_array($value)) {
$data = array();
if (! isset(self::$_data[$keyPath])) {
self::$_data[$keyPath] = array();
}
self::$_data[$keyPath] = array_replace_recursive(
self::$_data[$keyPath], (new SiteSettingUtilFunc())->writeArray($data, $value, $langId)
);
} else {
self::$_data = Hash::insert(self::$_data, $keyPath . '.' . $langId, $value);
}
}
/**
* 指定された$keyの値を削除します。
*
* サイト名(App.site_name)を削除したい場合
* ```
* SiteSetting::remove('App.site_name')
* ```
*
* @param string $keyPath Hashクラスのpath
* @param int|null $langId 言語ID(Language.id)
* @return void
*/
public static function remove($keyPath, $langId = null) {
if (! isset($langId) && strpos($keyPath, '.') !== false) {
$pathes = self::_tokenize($keyPath);
$tmp =& self::$_data;
$index = 0;
foreach ($pathes as $key) {
$index++;
if (count($pathes) === $index) {
unset($tmp[$key]);
} else {
$tmp =& $tmp[$key];
}
}
} else {
if (isset($langId)) {
self::$_data = Hash::remove(self::$_data, $keyPath . '.' . $langId);
} else {
self::$_data = Hash::remove(self::$_data, $keyPath);
}
}
self::$_data = array_filter(self::$_data);
}
/**
* 全てのデータをクリアする
*
* @return void
*/
public static function reset() {
self::$_data = array();
}
/**
* 全てのデータを取得
*
* @return array
*/
public static function readAll() {
return self::$_data;
}
/**
* CakeText::tokenizeをSiteSetting用に修正
*
* @param string $keyPath Hashクラスのpath
* @return array
*/
protected static function _tokenize($keyPath) {
$pathes = CakeText::tokenize($keyPath, '.', '[', ']');
$pathes = preg_replace('/[\[\]]/', '', $pathes);
return $pathes;
}
}