|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace leandrogehlen\exporter\serializers; |
|
4
|
|
|
|
|
5
|
|
|
use leandrogehlen\exporter\data\Column; |
|
6
|
|
|
use leandrogehlen\exporter\data\Dictionary; |
|
7
|
|
|
use leandrogehlen\exporter\data\Exporter; |
|
8
|
|
|
use leandrogehlen\exporter\data\Provider; |
|
9
|
|
|
use leandrogehlen\exporter\data\Session; |
|
10
|
|
|
use yii\base\InvalidConfigException; |
|
11
|
|
|
use yii\base\Object; |
|
12
|
|
|
use yii\db\Query; |
|
13
|
|
|
use yii\helpers\ArrayHelper; |
|
14
|
|
|
|
|
15
|
|
|
|
|
16
|
|
|
|
|
17
|
|
|
/** |
|
18
|
|
|
* Serializer converts DB data into specific before it is sent out |
|
19
|
|
|
* |
|
20
|
|
|
* @author Leandro Guindani Gehlen <[email protected]> |
|
21
|
|
|
*/ |
|
22
|
|
|
abstract class Serializer extends Object |
|
23
|
|
|
{ |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* @event Event an event raised at the beginning of serialize row |
|
27
|
|
|
*/ |
|
28
|
|
|
const EVENT_BEFORE_SERIALIZE_ROW = 'beforeSerializeRow'; |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
31
|
|
|
* @var Exporter |
|
32
|
|
|
*/ |
|
33
|
|
|
public $exporter; |
|
34
|
|
|
|
|
35
|
|
|
/** |
|
36
|
|
|
* Serializes the given session into a format that can be easily turned into other formats. |
|
37
|
|
|
* @param Session[] $sessions |
|
38
|
|
|
* @param array $master |
|
39
|
|
|
* @return array |
|
40
|
|
|
*/ |
|
41
|
|
|
abstract public function serialize($sessions, $master = []); |
|
42
|
|
|
|
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* Formats the specified data. |
|
46
|
|
|
* @param array $data |
|
47
|
|
|
* @return string |
|
48
|
|
|
*/ |
|
49
|
|
|
abstract public function formatData($data); |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* Executes the query statement and returns ALL rows at once. |
|
53
|
|
|
* @param Provider $provider the provider name |
|
54
|
|
|
* @return array |
|
55
|
|
|
* @throws InvalidConfigException |
|
56
|
|
|
*/ |
|
57
|
7 |
|
protected function executeProvider($provider, $master) |
|
58
|
|
|
{ |
|
59
|
7 |
|
$db = $this->exporter->db; |
|
60
|
7 |
|
$query = $provider->query; |
|
61
|
|
|
|
|
62
|
7 |
|
if ($query instanceof Query) { |
|
63
|
2 |
|
list($sql, $params) = $db->getQueryBuilder()->build($query); |
|
64
|
7 |
|
} elseif (is_string($query)) { |
|
65
|
6 |
|
$sql = $query; |
|
66
|
6 |
|
$params = []; |
|
67
|
6 |
|
} else { |
|
68
|
1 |
|
throw new InvalidConfigException('The query of provider "' . $provider->name . '" must be string or Query object'); |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
6 |
|
if (preg_match_all('/:\w+/', $sql, $matches)) { |
|
72
|
3 |
|
foreach ($matches[0] as $param) { |
|
73
|
3 |
|
$name = substr($param, 1); |
|
74
|
3 |
|
if (!isset($params[$name]) && !isset($params[$param])) { |
|
75
|
3 |
|
$value = ArrayHelper::getValue($master, $name); |
|
76
|
|
|
|
|
77
|
3 |
|
if ($value === null) { |
|
78
|
1 |
|
$parameter = $this->exporter->findParameter($name); |
|
79
|
1 |
|
if ($parameter !== null) { |
|
80
|
1 |
|
$value = is_callable($parameter->value) ? call_user_func($parameter->value) : $parameter->value; |
|
81
|
1 |
|
} |
|
82
|
1 |
|
} |
|
83
|
3 |
|
$params[$name] = $value; |
|
84
|
3 |
|
} |
|
85
|
3 |
|
} |
|
86
|
3 |
|
} |
|
87
|
|
|
|
|
88
|
6 |
|
return $db->createCommand($sql, $params)->queryAll(); |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
/** |
|
92
|
|
|
* This method is invoked before serialize row. |
|
93
|
|
|
* @param string|array $record |
|
94
|
|
|
* @param Session $session |
|
95
|
|
|
* @return string|array |
|
96
|
|
|
*/ |
|
97
|
5 |
|
public function beforeSerializeRow($record, $session) |
|
98
|
|
|
{ |
|
99
|
5 |
|
$event = $this->exporter->findEvent(self::EVENT_BEFORE_SERIALIZE_ROW); |
|
100
|
4 |
|
return ($event !== null) ? call_user_func($event->expression, $record, $session) : $record; |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
/** |
|
104
|
|
|
* Extract formatted value. |
|
105
|
|
|
* @param Column $column |
|
106
|
|
|
* @param array $row |
|
107
|
|
|
* @return mixed|string |
|
108
|
|
|
*/ |
|
109
|
6 |
|
protected function extractValue($column, $row) |
|
110
|
|
|
{ |
|
111
|
6 |
|
$complete = $column->complete; |
|
112
|
6 |
|
$size = $column->size; |
|
113
|
6 |
|
$format = $column->format; |
|
114
|
6 |
|
$align = $column->align; |
|
115
|
6 |
|
$expression = null; |
|
116
|
6 |
|
$value = ArrayHelper::getValue($row, $column->name); |
|
117
|
|
|
|
|
118
|
6 |
|
if (is_callable($column->value)){ |
|
119
|
4 |
|
$expression = $column->value; |
|
120
|
6 |
|
} elseif ($column->value !== null) { |
|
121
|
6 |
|
$value = $column->value; |
|
122
|
6 |
|
} |
|
123
|
|
|
|
|
124
|
6 |
|
$dictionary = $column->dictionary ? $this->exporter->findDictionary($column->dictionary) : null; |
|
125
|
6 |
|
if ($dictionary) { |
|
126
|
3 |
|
if ($dictionary->value) { |
|
127
|
3 |
|
if ($expression === null && is_callable($dictionary->value)) { |
|
128
|
1 |
|
$expression = $dictionary->value; |
|
129
|
3 |
|
} elseif ($value === null) { |
|
130
|
2 |
|
$value = $dictionary->value; |
|
131
|
2 |
|
} |
|
132
|
3 |
|
} |
|
133
|
3 |
|
if ($complete === null) { |
|
134
|
3 |
|
$complete = $dictionary->complete; |
|
135
|
3 |
|
} |
|
136
|
3 |
|
if ($align === null) { |
|
137
|
3 |
|
$align = $dictionary->align; |
|
138
|
3 |
|
} |
|
139
|
3 |
|
if ($size === null) { |
|
140
|
3 |
|
$size = $dictionary->size; |
|
141
|
3 |
|
} |
|
142
|
3 |
|
if ($format === null) { |
|
143
|
3 |
|
$format = $dictionary->format; |
|
144
|
3 |
|
} |
|
145
|
3 |
|
} |
|
146
|
|
|
|
|
147
|
6 |
|
if ($format) { |
|
148
|
1 |
|
$value = $this->exporter->formatter->format($value, $format); |
|
149
|
1 |
|
} |
|
150
|
|
|
|
|
151
|
6 |
|
if (is_callable($expression)) { |
|
152
|
4 |
|
$value = call_user_func($expression, $value, $row); |
|
153
|
4 |
|
} |
|
154
|
|
|
|
|
155
|
6 |
|
$value = (string) $value; |
|
156
|
6 |
|
if ($size === null) { |
|
157
|
3 |
|
return $value; |
|
158
|
|
|
} else { |
|
159
|
3 |
|
$padding = $this->toPadding($align); |
|
160
|
3 |
|
return ($size > strlen($value) && $complete !== null) ? str_pad($value, $size, $complete, $padding) : substr($value, 0, $size); |
|
161
|
|
|
} |
|
162
|
|
|
} |
|
163
|
|
|
|
|
164
|
|
|
/** |
|
165
|
|
|
* Converts the [[align]] property to valid padding type. |
|
166
|
|
|
* @see {@link http://php.net/manual/pt_BR/function.str-pad.php php manual}. |
|
167
|
|
|
* @param string $align the column alignment |
|
168
|
|
|
* @return int |
|
169
|
|
|
*/ |
|
170
|
3 |
|
private function toPadding($align) |
|
171
|
|
|
{ |
|
172
|
3 |
|
if ($align == Dictionary::ALIGN_RIGHT) { |
|
173
|
1 |
|
return STR_PAD_LEFT; |
|
174
|
3 |
|
} elseif ($align == Dictionary::ALIGN_BOTH) { |
|
175
|
|
|
return STR_PAD_BOTH; |
|
176
|
|
|
} else { |
|
177
|
3 |
|
return STR_PAD_RIGHT; |
|
178
|
|
|
} |
|
179
|
|
|
} |
|
180
|
|
|
} |
|
181
|
|
|
|
leandrogehlen /
yii2-data-exporter
