LanguageBehavior.php
7.38 KB
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
<?php
namespace common\modules\language\behaviors;
use common\modules\language\models\Language;
use yii\base\Behavior;
use yii\base\InvalidConfigException;
use yii\db\ActiveQuery;
use yii\db\ActiveRecord;
use yii\web\Request;
/**
* Class LanguageBehavior
* @property ActiveRecord $owner
* @property string $ownerKey
* @property string $langKey
* @property ActiveRecord[] $langs
* @property ActiveRecord $lang
*/
class LanguageBehavior extends Behavior
{
/**
* @var ActiveRecord $object_lang Empty language model for $owner
*/
public $object_lang;
private $_owner_key;
private $_lang_key;
/**
* Get $owner primary key to link language model
* @return string
*/
public function getOwnerKey():string
{
if(!empty( $this->_owner_key )) {
return $this->_owner_key;
} else {
return $this->owner->primaryKey()[ 0 ];
}
}
/**
* Set which attribute to use as $owner primary key to link language model
*
* @param string $value
*/
public function setOwnerKey(string $value)
{
$this->_owner_key = $value;
}
/**
* Get language model attribute that is used as foreign key to $owner
* @return string
*/
public function getLangKey():string
{
if(!empty( $this->_lang_key )) {
return $this->_lang_key;
} else {
$owner = $this->owner;
return $owner::getTableSchema()->name . '_id';
}
}
/**
* Set which attribute to use as language model foreign key to $owner
*
* @param $value
*/
public function setLangKey(string $value)
{
$this->_lang_key = $value;
}
/**
* Additional checks to attach this behavior
*
* @param ActiveRecord $owner
*
* @throws InvalidConfigException
*/
public function attach($owner)
{
if(empty( $this->object_lang )) {
$this->object_lang = $owner::className() . 'Lang';
} elseif(!is_string($this->object_lang)) {
throw new InvalidConfigException('Object lang must be fully classified namespaced classname');
}
try {
$this->object_lang = \Yii::createObject($this->object_lang);
} catch(\ReflectionException $exception) {
throw new InvalidConfigException('Object lang must be fully classified namespaced classname');
}
if(( !$owner instanceof ActiveRecord ) || ( !$this->object_lang instanceof ActiveRecord )) {
throw new InvalidConfigException('Object lang must be fully classified namespaced classname');
}
parent::attach($owner);
}
/**
* Get query to get all language models for $owner indexed by language_id
* @return ActiveQuery
*/
public function getLangs()
{
$object_lang = $this->object_lang;
$owner = $this->owner;
return $owner->hasMany($object_lang::className(), [ $this->getLangKey() => $this->getOwnerKey() ])
->indexBy('language_id');
}
/**
* Get query to get language model for $owner for language_id, default to
* Language::getCurrent()
*
* @param int $language_id
*
* @return ActiveQuery
*/
public function getLang(int $language_id = NULL)
{
if(empty( $language_id )) {
$language_id = Language::getCurrent()->language_id;
}
$object_lang = $this->object_lang;
$table_name = $object_lang::getTableSchema()->name;
$owner = $this->owner;
return $owner->hasOne($object_lang::className(), [ $this->getLangKey() => $this->getOwnerKey() ])
->where([ $table_name.'.language_id' => $language_id ]);
}
/**
* Generate language models for $owner for active languages. If $owner not new and language
* models already inserted, models will be filled with them.
* @return ActiveRecord[]
*/
public function generateLangs()
{
$owner = $this->owner;
$languages = Language::find()
->where([ 'status' => true ])
->asArray()
->column();
$object_lang = $this->object_lang;
$owner_key = $this->getOwnerKey();
$langs = [];
if(!$owner->isNewRecord) {
$langs = $this->getLangs()
->andFilterWhere([ 'language_id' => $languages ])
->all();
}
foreach($languages as $language) {
if(!array_key_exists($language, $langs)) {
$langs[ $language ] = \Yii::createObject([
'class' => $object_lang::className(),
'language_id' => $language,
$this->getLangKey() => ( $owner->isNewRecord ? NULL : $owner->$owner_key ),
]);
}
}
return $langs;
}
/**
* Load language models with post data.
*
* @param Request $request
* @param ActiveRecord[] $model_langs
*/
public function loadLangs(Request $request, array $model_langs)
{
foreach($request->post($this->object_lang->formName(), []) as $lang => $value) {
if(!empty( $model_langs[ $lang ] )) {
$model_langs[ $lang ]->attributes = $value;
$model_langs[ $lang ]->language_id = $lang;
}
}
}
/**
* Link language models with $owner by setting language model language key to owner key of
* owner
*
* @param ActiveRecord[] $model_langs
*
* @return bool If $owner is new record then return false else true
*/
public function linkLangs(array $model_langs)
{
$owner = $this->owner;
if($owner->isNewRecord) {
return false;
}
$lang_key = $this->getLangKey();
$owner_key = $this->getOwnerKey();
foreach($model_langs as $model_lang) {
$model_lang->$lang_key = $owner->$owner_key;
}
return true;
}
/**
* Try to save all language models to the db. Validation function is run for all models.
*
* @param ActiveRecord[] $model_langs
*
* @return bool Whether all models are valid
*/
public function saveLangs(array $model_langs)
{
$success = true;
foreach($model_langs as $model_lang) {
if(!$model_lang->save()) {
$success = false;
}
}
return $success;
}
}