1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Disqus plugin for Craft CMS 3.x |
4
|
|
|
* |
5
|
|
|
* Integrates the Disqus commenting system into Craft 3 websites, including |
6
|
|
|
* Single Sign On (SSO) and custom login/logout URLs |
7
|
|
|
* |
8
|
|
|
* @link https://nystudio107.com |
|
|
|
|
9
|
|
|
* @copyright Copyright (c) 2017 nystudio107 |
|
|
|
|
10
|
|
|
*/ |
|
|
|
|
11
|
|
|
|
12
|
|
|
namespace nystudio107\disqus\models; |
13
|
|
|
|
14
|
|
|
use Craft; |
15
|
|
|
use craft\base\Model; |
16
|
|
|
use craft\behaviors\EnvAttributeParserBehavior; |
17
|
|
|
use nystudio107\disqus\Disqus; |
18
|
|
|
use yii\behaviors\AttributeTypecastBehavior; |
19
|
|
|
|
20
|
|
|
/** |
|
|
|
|
21
|
|
|
* @author nystudio107 |
|
|
|
|
22
|
|
|
* @package Disqus |
|
|
|
|
23
|
|
|
* @since 1.0.0 |
|
|
|
|
24
|
|
|
*/ |
|
|
|
|
25
|
|
|
class Settings extends Model |
26
|
|
|
{ |
27
|
|
|
// Public Properties |
28
|
|
|
// ========================================================================= |
29
|
|
|
|
30
|
|
|
/** |
|
|
|
|
31
|
|
|
* @var bool |
32
|
|
|
*/ |
33
|
|
|
public $lazyLoadDisqus = true; |
34
|
|
|
|
35
|
|
|
/** |
|
|
|
|
36
|
|
|
* @var string |
37
|
|
|
*/ |
38
|
|
|
public $disqusShortname = ''; |
39
|
|
|
|
40
|
|
|
/** |
|
|
|
|
41
|
|
|
* @var bool |
42
|
|
|
*/ |
43
|
|
|
public $useSSO = false; |
44
|
|
|
|
45
|
|
|
/** |
|
|
|
|
46
|
|
|
* @var string |
47
|
|
|
*/ |
48
|
|
|
public $disqusPublicKey = ''; |
49
|
|
|
|
50
|
|
|
/** |
|
|
|
|
51
|
|
|
* @var string |
52
|
|
|
*/ |
53
|
|
|
public $disqusSecretKey = ''; |
54
|
|
|
|
55
|
|
|
/** |
|
|
|
|
56
|
|
|
* @var bool |
57
|
|
|
*/ |
58
|
|
|
public $customLogin = false; |
59
|
|
|
|
60
|
|
|
/** |
|
|
|
|
61
|
|
|
* @var string |
62
|
|
|
*/ |
63
|
|
|
public $loginName = ''; |
64
|
|
|
|
65
|
|
|
/** |
|
|
|
|
66
|
|
|
* @var string |
67
|
|
|
*/ |
68
|
|
|
public $loginButton = ''; |
69
|
|
|
|
70
|
|
|
/** |
|
|
|
|
71
|
|
|
* @var string |
72
|
|
|
*/ |
73
|
|
|
public $loginIcon = ''; |
74
|
|
|
|
75
|
|
|
/** |
|
|
|
|
76
|
|
|
* @var string |
77
|
|
|
*/ |
78
|
|
|
public $loginUrl = ''; |
79
|
|
|
|
80
|
|
|
/** |
|
|
|
|
81
|
|
|
* @var string |
82
|
|
|
*/ |
83
|
|
|
public $loginLogoutUrl = ''; |
84
|
|
|
|
85
|
|
|
/** |
|
|
|
|
86
|
|
|
* @var int |
87
|
|
|
*/ |
88
|
|
|
public $loginWidth = 800; |
89
|
|
|
|
90
|
|
|
/** |
|
|
|
|
91
|
|
|
* @var int |
92
|
|
|
*/ |
93
|
|
|
public $loginHeight = 400; |
94
|
|
|
|
95
|
|
|
// Public Methods |
96
|
|
|
// ========================================================================= |
97
|
|
|
|
98
|
|
|
/** |
|
|
|
|
99
|
|
|
* @return string the parsed secret key (e.g. 'XXXXXXXXXXX') |
100
|
|
|
*/ |
101
|
|
|
public function getDisqusSecretKey(): string |
102
|
|
|
{ |
103
|
|
|
return Disqus::$craft31 ? Craft::parseEnv($this->disqusSecretKey) : $this->disqusSecretKey; |
|
|
|
|
104
|
|
|
} |
105
|
|
|
|
106
|
|
|
/** |
|
|
|
|
107
|
|
|
* @return string the parsed public key (e.g. 'XXXXXXXXXXX') |
108
|
|
|
*/ |
109
|
|
|
public function getDisqusPublicKey(): string |
110
|
|
|
{ |
111
|
|
|
return Disqus::$craft31 ? Craft::parseEnv($this->disqusPublicKey) : $this->disqusPublicKey; |
|
|
|
|
112
|
|
|
} |
113
|
|
|
|
114
|
|
|
/** |
|
|
|
|
115
|
|
|
* @return string |
116
|
|
|
*/ |
117
|
|
|
public function getDisqusShortname(): string |
118
|
|
|
{ |
119
|
|
|
return $this->disqusShortname; |
120
|
|
|
} |
121
|
|
|
|
122
|
|
|
/** |
|
|
|
|
123
|
|
|
* @return bool |
124
|
|
|
*/ |
125
|
|
|
public function getUseSSO(): bool |
126
|
|
|
{ |
127
|
|
|
return $this->useSSO; |
128
|
|
|
} |
129
|
|
|
|
130
|
|
|
/** |
|
|
|
|
131
|
|
|
* @return bool |
132
|
|
|
*/ |
133
|
|
|
public function getCustomLogin(): bool |
134
|
|
|
{ |
135
|
|
|
return $this->customLogin; |
136
|
|
|
} |
137
|
|
|
|
138
|
|
|
/** |
|
|
|
|
139
|
|
|
* @return string |
140
|
|
|
*/ |
141
|
|
|
public function getLoginName(): string |
142
|
|
|
{ |
143
|
|
|
return Disqus::$craft31 ? Craft::parseEnv($this->loginName) : $this->loginName; |
|
|
|
|
144
|
|
|
} |
145
|
|
|
|
146
|
|
|
/** |
|
|
|
|
147
|
|
|
* @return string |
148
|
|
|
*/ |
149
|
|
|
public function getLoginButton(): string |
150
|
|
|
{ |
151
|
|
|
return Disqus::$craft31 ? Craft::parseEnv($this->loginButton) : $this->loginButton; |
|
|
|
|
152
|
|
|
} |
153
|
|
|
|
154
|
|
|
/** |
|
|
|
|
155
|
|
|
* @return string |
156
|
|
|
*/ |
157
|
|
|
public function getLoginIcon(): string |
158
|
|
|
{ |
159
|
|
|
return Disqus::$craft31 ? Craft::parseEnv($this->loginIcon) : $this->loginIcon; |
|
|
|
|
160
|
|
|
} |
161
|
|
|
|
162
|
|
|
/** |
|
|
|
|
163
|
|
|
* @return string |
164
|
|
|
*/ |
165
|
|
|
public function getLoginUrl(): string |
166
|
|
|
{ |
167
|
|
|
return Disqus::$craft31 ? Craft::parseEnv($this->loginUrl) : $this->loginUrl; |
|
|
|
|
168
|
|
|
} |
169
|
|
|
|
170
|
|
|
/** |
|
|
|
|
171
|
|
|
* @return string |
172
|
|
|
*/ |
173
|
|
|
public function getLoginLogoutUrl(): string |
174
|
|
|
{ |
175
|
|
|
return Disqus::$craft31 ? Craft::parseEnv($this->loginLogoutUrl) : $this->loginLogoutUrl; |
|
|
|
|
176
|
|
|
} |
177
|
|
|
|
178
|
|
|
/** |
|
|
|
|
179
|
|
|
* @return int |
180
|
|
|
*/ |
181
|
|
|
public function getLoginWidth(): int |
182
|
|
|
{ |
183
|
|
|
return $this->loginWidth; |
184
|
|
|
} |
185
|
|
|
|
186
|
|
|
/** |
|
|
|
|
187
|
|
|
* @return int |
188
|
|
|
*/ |
189
|
|
|
public function getLoginHeight(): int |
190
|
|
|
{ |
191
|
|
|
return $this->loginHeight; |
192
|
|
|
} |
193
|
|
|
|
194
|
|
|
/** |
|
|
|
|
195
|
|
|
* @inheritdoc |
196
|
|
|
*/ |
|
|
|
|
197
|
|
|
public function rules() |
198
|
|
|
{ |
199
|
|
|
return [ |
200
|
|
|
['lazyLoadDisqus', 'boolean'], |
201
|
|
|
['lazyLoadDisqus', 'default', 'value' => false], |
202
|
|
|
['disqusShortname', 'string'], |
203
|
|
|
['disqusShortname', 'default', 'value' => ''], |
204
|
|
|
['useSSO', 'boolean'], |
205
|
|
|
['useSSO', 'default', 'value' => false], |
206
|
|
|
['disqusPublicKey', 'string'], |
207
|
|
|
['disqusPublicKey', 'default', 'value' => ''], |
208
|
|
|
['disqusSecretKey', 'string'], |
209
|
|
|
['disqusSecretKey', 'default', 'value' => ''], |
210
|
|
|
['customLogin', 'boolean'], |
211
|
|
|
['customLogin', 'default', 'value' => false], |
212
|
|
|
['loginName', 'string'], |
213
|
|
|
['loginName', 'default', 'value' => ''], |
214
|
|
|
['loginButton', 'string'], |
215
|
|
|
['loginButton', 'default', 'value' => ''], |
216
|
|
|
['loginIcon', 'string'], |
217
|
|
|
['loginIcon', 'default', 'value' => ''], |
218
|
|
|
['loginUrl', 'string'], |
219
|
|
|
['loginUrl', 'default', 'value' => ''], |
220
|
|
|
['loginLogoutUrl', 'string'], |
221
|
|
|
['loginLogoutUrl', 'default', 'value' => ''], |
222
|
|
|
['loginWidth', 'integer', 'min' => 400, 'max' => 2000], |
223
|
|
|
['loginWidth', 'default', 'value' => 800], |
224
|
|
|
['loginHeight', 'integer', 'min' => 200, 'max' => 1000], |
225
|
|
|
['loginHeight', 'default', 'value' => 400], |
226
|
|
|
]; |
227
|
|
|
} |
228
|
|
|
|
229
|
|
|
|
230
|
|
|
/** |
|
|
|
|
231
|
|
|
* @return array |
232
|
|
|
*/ |
233
|
|
|
public function behaviors() |
234
|
|
|
{ |
235
|
|
|
$craft31Behaviors = []; |
236
|
|
|
if (Disqus::$craft31) { |
237
|
|
|
$craft31Behaviors = [ |
238
|
|
|
'parser' => [ |
239
|
|
|
'class' => EnvAttributeParserBehavior::class, |
240
|
|
|
'attributes' => [ |
241
|
|
|
'loginName', |
242
|
|
|
'loginButton', |
243
|
|
|
'loginIcon', |
244
|
|
|
'loginUrl', |
245
|
|
|
'loginLogoutUrl', |
246
|
|
|
'disqusPublicKey', |
247
|
|
|
'disqusSecretKey', |
248
|
|
|
], |
249
|
|
|
], |
250
|
|
|
]; |
251
|
|
|
} |
252
|
|
|
|
253
|
|
|
return array_merge($craft31Behaviors, [ |
|
|
|
|
254
|
|
|
'typecast' => [ |
255
|
|
|
'class' => AttributeTypecastBehavior::class, |
256
|
|
|
// 'attributeTypes' will be composed automatically according to `rules()` |
257
|
|
|
], |
258
|
|
|
]); |
|
|
|
|
259
|
|
|
} |
260
|
|
|
} |
261
|
|
|
|