Newer
Older
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
<?php
/**
* @file
* Definition of Drupal\locale\StringDatabaseStorage.
*/
namespace Drupal\locale;
use Drupal\Core\Database\Database;
use Drupal\Core\Database\Connection;
use PDO;
/**
* Defines the locale string class.
*
* This is the base class for SourceString and TranslationString.
*/
class StringDatabaseStorage implements StringStorageInterface {
/**
* The database connection.
*
* @var Drupal\Core\Database\Connection
*/
protected $connection;
/**
* Additional database connection options to use in queries.
*
* @var array
*/
protected $options = array();
/**
* Constructs a new StringStorage controller.
*
* @param Drupal\Core\Database\Connection $connection
* A Database connection to use for reading and writing configuration data.
* @param array $options
* (optional) Any additional database connection options to use in queries.
*/
public function __construct(Connection $connection, array $options = array()) {
$this->connection = $connection;
$this->options = $options;
}
/**
* Implements Drupal\locale\StringStorageInterface::getStrings().
*/
public function getStrings(array $conditions = array(), array $options = array()) {
return $this->dbStringLoad($conditions, $options, 'Drupal\locale\SourceString');
}
/**
* Implements Drupal\locale\StringStorageInterface::getTranslations().
*/
public function getTranslations(array $conditions = array(), array $options = array()) {
Angie Byron
committed
return $this->dbStringLoad($conditions, array('translation' => TRUE) + $options, 'Drupal\locale\TranslationString');
}
/**
* Implements Drupal\locale\StringStorageInterface::findString().
*/
Angie Byron
committed
public function findString(array $conditions) {
$string = $this->dbStringSelect($conditions)
->execute()
->fetchObject('Drupal\locale\SourceString');
if ($string) {
$string->setStorage($this);
}
return $string;
}
/**
* Implements Drupal\locale\StringStorageInterface::findTranslation().
*/
Angie Byron
committed
public function findTranslation(array $conditions) {
$string = $this->dbStringSelect($conditions, array('translation' => TRUE))
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
316
317
318
319
320
321
322
->execute()
->fetchObject('Drupal\locale\TranslationString');
if ($string) {
$string->setStorage($this);
}
return $string;
}
/**
* Implements Drupal\locale\StringStorageInterface::countStrings().
*/
public function countStrings() {
return $this->dbExecute("SELECT COUNT(*) FROM {locales_source}")->fetchField();
}
/**
* Implements Drupal\locale\StringStorageInterface::countTranslations().
*/
public function countTranslations() {
return $this->dbExecute("SELECT t.language, COUNT(*) AS translated FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid GROUP BY t.language")->fetchAllKeyed();
}
/**
* Implements Drupal\locale\StringStorageInterface::checkVersion().
*/
public function checkVersion($string, $version) {
if ($string->getId() && $string->getVersion() != $version) {
$string->setVersion($version);
$this->connection->update('locales_source', $this->options)
->condition('lid', $string->getId())
->fields(array('version' => $version))
->execute();
}
}
/**
* Implements Drupal\locale\StringStorageInterface::save().
*/
public function save($string) {
if ($string->isNew()) {
$result = $this->dbStringInsert($string);
if ($string->isSource() && $result) {
// Only for source strings, we set the locale identifier.
$string->setId($result);
}
$string->setStorage($this);
}
else {
$this->dbStringUpdate($string);
}
return $this;
}
/**
* Implements Drupal\locale\StringStorageInterface::delete().
*/
public function delete($string) {
if ($keys = $this->dbStringKeys($string)) {
$this->dbDelete('locales_target', $keys)->execute();
if ($string->isSource()) {
$this->dbDelete('locales_source', $keys)->execute();
$string->setId(NULL);
}
}
else {
throw new StringStorageException(format_string('The string cannot be deleted because it lacks some key fields: @string', array(
'@string' => $string->getString()
)));
}
return $this;
}
/**
* Implements Drupal\locale\StringStorageInterface::deleteLanguage().
*/
public function deleteStrings($conditions) {
$lids = $this->dbStringSelect($conditions, array('fields' => array('lid')))->execute()->fetchCol();
if ($lids) {
$this->dbDelete('locales_target', array('lid' => $lids))->execute();
$this->dbDelete('locales_source', array('lid' => $lids))->execute();
}
}
/**
* Implements Drupal\locale\StringStorageInterface::deleteLanguage().
*/
public function deleteTranslations($conditions) {
$this->dbDelete('locales_target', $conditions)->execute();
}
/**
* Implements Drupal\locale\StringStorageInterface::createString().
*/
public function createString($values = array()) {
return new SourceString($values + array('storage' => $this));
}
/**
* Implements Drupal\locale\StringStorageInterface::createTranslation().
*/
public function createTranslation($values = array()) {
return new TranslationString($values + array(
'storage' => $this,
'is_new' => TRUE
));
}
/**
* Gets table alias for field.
*
* @param string $field
* Field name to find the table alias for.
*
* @return string
* Either 's' or 't' depending on whether the field belongs to source or
* target table.
*/
protected function dbFieldTable($field) {
return in_array($field, array('language', 'translation', 'customized')) ? 't' : 's';
}
/**
* Gets table name for storing string object.
*
* @param Drupal\locale\StringInterface $string
* The string object.
*
* @return string
* The table name.
*/
protected function dbStringTable($string) {
if ($string->isSource()) {
return 'locales_source';
}
elseif ($string->isTranslation()) {
return 'locales_target';
}
}
/**
* Gets keys values that are in a database table.
*
* @param Drupal\locale\StringInterface $string
* The string object.
* @param string $table
* (optional) The table name.
*
* @return array
* Array with key fields if the string has all keys, or empty array if not.
*/
protected function dbStringKeys($string, $table = NULL) {
$table = $table ? $table : $this->dbStringTable($string);
if ($table && $schema = drupal_get_schema($table)) {
$keys = $schema['primary key'];
$values = $string->getValues($keys);
if (count($values) == count($keys)) {
return $values;
}
}
return NULL;
}
/**
* Gets field values from a string object that are in the database table.
*
* @param Drupal\locale\StringInterface $string
* The string object.
* @param string $table
* (optional) The table name.
*
* @return array
* Array with field values indexed by field name.
*/
protected function dbStringValues($string, $table = NULL) {
$table = $table ? $table : $this->dbStringTable($string);
if ($table && $schema = drupal_get_schema($table)) {
$fields = array_keys($schema['fields']);
return $string->getValues($fields);
}
else {
return array();
}
}
/**
* Sets default values from storage.
*
* @param Drupal\locale\StringInterface $string
* The string object.
* @param string $table
* (optional) The table name.
*/
protected function dbStringDefaults($string, $table = NULL) {
$table = $table ? $table : $this->dbStringTable($string);
if ($table && $schema = drupal_get_schema($table)) {
$values = array();
foreach ($schema['fields'] as $name => $info) {
if (isset($info['default'])) {
$values[$name] = $info['default'];
}
}
$string->setValues($values, FALSE);
}
}
/**
* Loads multiple string objects.
*
* @param array $conditions
* Any of the conditions used by dbStringSelect().
* @param array $options
* Any of the options used by dbStringSelect().
* @param string $class
* Class name to use for fetching returned objects.
*
* @return array
* Array of objects of the class requested.
*/
protected function dbStringLoad(array $conditions, array $options, $class) {
$result = $this->dbStringSelect($conditions, $options)->execute();
$result->setFetchMode(PDO::FETCH_CLASS, $class);
$strings = $result->fetchAll();
foreach ($strings as $string) {
$string->setStorage($this);
}
return $strings;
}
/**
* Builds a SELECT query with multiple conditions and fields.
*
* The query uses both 'locales_source' and 'locales_target' tables.
* Note that by default, as we are selecting both translated and untranslated
* strings target field's conditions will be modified to match NULL rows too.
*
* @param array $conditions
* An associative array with field => value conditions that may include
* NULL values. If a language condition is included it will be used for
* joining the 'locales_target' table.
* @param array $options
* An associative array of additional options. It may contain any of the
* options used by Drupal\locale\StringStorageInterface::getStrings() and
* these additional ones:
Angie Byron
committed
* - 'translation', Whether to include translation fields too. Defaults to
* FALSE.
* @return SelectQuery
* Query object with all the tables, fields and conditions.
*/
protected function dbStringSelect(array $conditions, array $options = array()) {
Angie Byron
committed
// Start building the query with source table and check whether we need to
// join the target table too.
$query = $this->connection->select('locales_source', 's', $this->options)
->fields('s');
// Figure out how to join and translate some options into conditions.
if (isset($conditions['translated'])) {
// This is a meta-condition we need to translate into simple ones.
if ($conditions['translated']) {
// Select only translated strings.
$join = 'innerJoin';
}
else {
// Select only untranslated strings.
$join = 'leftJoin';
$conditions['translation'] = NULL;
}
unset($conditions['translated']);
}
else {
Angie Byron
committed
$join = !empty($options['translation']) ? 'leftJoin' : FALSE;
}
if ($join) {
if (isset($conditions['language'])) {
// If we've got a language condition, we use it for the join.
$query->$join('locales_target', 't', "t.lid = s.lid AND t.language = :langcode", array(
':langcode' => $conditions['language']
));
unset($conditions['language']);
}
else {
// Since we don't have a language, join with locale id only.
$query->$join('locales_target', 't', "t.lid = s.lid");
}
Angie Byron
committed
if (!empty($options['translation'])) {
// We cannot just add all fields because 'lid' may get null values.
$query->fields('t', array('language', 'translation', 'customized'));
}
}
Angie Byron
committed
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
// Add conditions for both tables.
foreach ($conditions as $field => $value) {
$table_alias = $this->dbFieldTable($field);
$field_alias = $table_alias . '.' . $field;
if (is_null($value)) {
$query->isNull($field_alias);
}
elseif ($table_alias == 't' && $join === 'leftJoin') {
// Conditions for target fields when doing an outer join only make
// sense if we add also OR field IS NULL.
$query->condition(db_or()
->condition($field_alias, $value)
->isNull($field_alias)
);
}
else {
$query->condition($field_alias, $value);
}
}
// Process other options, string filter, query limit, etc...
if (!empty($options['filters'])) {
if (count($options['filters']) > 1) {
$filter = db_or();
$query->condition($filter);
}
else {
// If we have a single filter, just add it to the query.
$filter = $query;
}
foreach ($options['filters'] as $field => $string) {
$filter->condition($this->dbFieldTable($field) . '.' . $field, '%' . db_like($string) . '%', 'LIKE');
}
}
if (!empty($options['pager limit'])) {
$query = $query->extend('Drupal\Core\Database\Query\PagerSelectExtender')->limit($options['pager limit']);
}
return $query;
}
/**
* Createds a database record for a string object.
*
* @param Drupal\locale\StringInterface $string
* The string object.
*
* @return bool|int
* If the operation failed, returns FALSE.
* If it succeeded returns the last insert ID of the query, if one exists.
*
* @throws Drupal\locale\StringStorageException
* If the string is not suitable for this storage, an exception ithrown.
*/
protected function dbStringInsert($string) {
if (($table = $this->dbStringTable($string)) && ($fields = $this->dbStringValues($string, $table))) {
$this->dbStringDefaults($string, $table);
return $this->connection->insert($table, $this->options)
Angie Byron
committed
->fields($fields)
->execute();
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
}
else {
throw new StringStorageException(format_string('The string cannot be saved: @string', array(
'@string' => $string->getString()
)));
}
}
/**
* Updates string object in the database.
*
* @param Drupal\locale\StringInterface $string
* The string object.
*
* @return bool|int
* If the record update failed, returns FALSE. If it succeeded, returns
* SAVED_NEW or SAVED_UPDATED.
*
* @throws Drupal\locale\StringStorageException
* If the string is not suitable for this storage, an exception is thrown.
*/
protected function dbStringUpdate($string) {
if (($table = $this->dbStringTable($string)) && ($keys = $this->dbStringKeys($string, $table)) &&
($fields = $this->dbStringValues($string, $table)) && ($values = array_diff_key($fields, $keys)))
{
return $this->connection->merge($table, $this->options)
->key($keys)
->fields($values)
->execute();
}
else {
throw new StringStorageException(format_string('The string cannot be updated: @string', array(
'@string' => $string->getString()
)));
}
}
/**
* Creates delete query.
*
* @param string $table
* The table name.
* @param array $keys
* Array with object keys indexed by field name.
*
* @return DeleteQuery
* Returns a new DeleteQuery object for the active database.
*/
protected function dbDelete($table, $keys) {
$query = $this->connection->delete($table, $this->options);
foreach ($keys as $field => $value) {
$query->condition($field, $value);
}
return $query;
}
/**
* Executes an arbitrary SELECT query string.
*/
protected function dbExecute($query, array $args = array()) {
return $this->connection->query($query, $args, $this->options);
}
}