|
1
|
|
|
<?php |
|
2
|
|
|
namespace keeko\tools\generator; |
|
3
|
|
|
|
|
4
|
|
|
use gossi\codegen\model\PhpClass; |
|
5
|
|
|
use gossi\codegen\model\PhpMethod; |
|
6
|
|
|
use gossi\codegen\model\PhpParameter; |
|
7
|
|
|
use keeko\framework\utils\NameUtils; |
|
8
|
|
|
use keeko\tools\generator\AbstractCodeGenerator; |
|
9
|
|
|
use Propel\Generator\Model\Table; |
|
10
|
|
|
use phootwork\file\File; |
|
11
|
|
|
|
|
12
|
|
|
class SerializerGenerator extends AbstractCodeGenerator { |
|
13
|
|
|
|
|
14
|
|
|
protected function getTemplateFolder() { |
|
15
|
|
|
return 'serializer'; |
|
16
|
|
|
} |
|
17
|
|
|
|
|
18
|
|
|
public function generate(Table $model) { |
|
19
|
|
|
$fqcn = sprintf('%s\\serializer\\%sSerializer', $model->getNamespace(), $model->getPhpName()); |
|
20
|
|
|
$class = new PhpClass($fqcn); |
|
21
|
|
|
// $file = new File($this->codegenService->getFilename($class)); |
|
|
|
|
|
|
22
|
|
|
// if ($file->exists()) { |
|
23
|
|
|
// $class = PhpClass::fromFile($file->getPathname()); |
|
24
|
|
|
// } |
|
25
|
|
|
$class->setParentClassName('AbstractSerializer'); |
|
26
|
|
|
$class->addUseStatement('keeko\\framework\\model\\AbstractSerializer'); |
|
27
|
|
|
|
|
28
|
|
|
$this->generateIdentifyingMethods($class, $model); |
|
29
|
|
|
$this->generateAttributeMethods($class, $model); |
|
30
|
|
|
$this->generateHydrateMethod($class, $model); |
|
31
|
|
|
$this->generateRelationshipMethods($class, $model); |
|
32
|
|
|
|
|
33
|
|
|
return $class; |
|
34
|
|
|
} |
|
35
|
|
|
|
|
36
|
|
|
protected function generateIdentifyingMethods(PhpClass $class, Table $model) { |
|
37
|
|
|
$package = $this->packageService->getPackage(); |
|
38
|
|
|
$type = sprintf('%s/%s', $package->getCleanName(), NameUtils::dasherize($model->getOriginCommonName())); |
|
|
|
|
|
|
39
|
|
|
|
|
40
|
|
|
$class->setMethod(PhpMethod::create('getId') |
|
41
|
|
|
->addParameter(PhpParameter::create('model')) |
|
42
|
|
|
->setBody($this->twig->render('getId.twig')) |
|
43
|
|
|
); |
|
44
|
|
|
|
|
45
|
|
|
$class->setMethod(PhpMethod::create('getType') |
|
46
|
|
|
->addParameter(PhpParameter::create('model')) |
|
47
|
|
|
->setBody($this->twig->render('getType.twig', [ |
|
48
|
|
|
'type' => $type |
|
49
|
|
|
])) |
|
50
|
|
|
); |
|
51
|
|
|
} |
|
52
|
|
|
|
|
53
|
|
|
protected function generateAttributeMethods(PhpClass $class, Table $model) { |
|
54
|
|
|
$writeFields = $this->codegenService->getWriteFields($model->getOriginCommonName()); |
|
55
|
|
|
$attrs = ''; |
|
56
|
|
|
|
|
57
|
|
|
foreach ($writeFields as $field) { |
|
58
|
|
|
$col = $model->getColumn($field); |
|
59
|
|
|
$param = $col->isTemporalType() ? '\DateTime::ISO8601' : ''; |
|
60
|
|
|
$attrs .= sprintf("\t'%s' => \$model->%s(%s),\n", $field, $col->getPhpName(), $param); |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
if (count($field) > 0) { |
|
|
|
|
|
|
64
|
|
|
$attrs = substr($attrs, 0, -1); |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
$class->setMethod(PhpMethod::create('getAttributes') |
|
68
|
|
|
->addParameter(PhpParameter::create('model')) |
|
69
|
|
|
->addParameter(PhpParameter::create('fields')->setType('array')->setDefaultValue(null)) |
|
70
|
|
|
->setBody($this->twig->render('getAttributes.twig', [ |
|
71
|
|
|
'attrs' => $attrs |
|
72
|
|
|
])) |
|
73
|
|
|
); |
|
74
|
|
|
|
|
75
|
|
|
$class->setMethod(PhpMethod::create('getSortFields') |
|
76
|
|
|
->setBody($this->twig->render('getFields.twig', [ |
|
77
|
|
|
'fields' => $this->codegenService->arrayToCode($writeFields) |
|
78
|
|
|
])) |
|
79
|
|
|
); |
|
80
|
|
|
|
|
81
|
|
|
$readFields = $this->codegenService->getReadFields($model->getOriginCommonName()); |
|
82
|
|
|
$class->setMethod(PhpMethod::create('getFields') |
|
83
|
|
|
->setBody($this->twig->render('getFields.twig', [ |
|
84
|
|
|
'fields' => $this->codegenService->arrayToCode($readFields) |
|
85
|
|
|
])) |
|
86
|
|
|
); |
|
87
|
|
|
} |
|
88
|
|
|
|
|
89
|
|
|
protected function generateHydrateMethod(PhpClass $class, Table $model) { |
|
90
|
|
|
if ($model->isReadOnly()) { |
|
91
|
|
|
$body = $this->twig->render('hydrate-readonly.twig'); |
|
92
|
|
|
} else { |
|
93
|
|
|
$class->addUseStatement('keeko\\framework\\utils\\HydrateUtils'); |
|
94
|
|
|
$modelName = $model->getOriginCommonName(); |
|
95
|
|
|
$conversions = $this->codegenService->getCodegen()->getWriteConversion($modelName); |
|
96
|
|
|
$fields = $this->codegenService->getWriteFields($modelName); |
|
97
|
|
|
$code = ''; |
|
98
|
|
|
|
|
99
|
|
|
foreach ($fields as $field) { |
|
100
|
|
|
$code .= "'$field'"; |
|
|
|
|
|
|
101
|
|
|
if (isset($conversions[$field])) { |
|
102
|
|
|
$code .= ' => function($v) {'."\n\t".'return ' . $conversions[$field] . ';'."\n".'}'; |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
$code .= ', '; |
|
106
|
|
|
} |
|
107
|
|
|
|
|
108
|
|
|
if (strlen($code) > 0) { |
|
109
|
|
|
$code = substr($code, 0, -2); |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
$code = sprintf('[%s]', $code); |
|
113
|
|
|
$body = $this->twig->render('hydrate.twig', [ |
|
114
|
|
|
'code' => $code |
|
115
|
|
|
]); |
|
116
|
|
|
} |
|
117
|
|
|
|
|
118
|
|
|
$class->setMethod(PhpMethod::create('hydrate') |
|
119
|
|
|
->addParameter(PhpParameter::create('model')) |
|
120
|
|
|
->addParameter(PhpParameter::create('data')) |
|
121
|
|
|
->setBody($body) |
|
122
|
|
|
); |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
|
|
protected function generateRelationshipMethods(PhpClass $class, Table $model) { |
|
126
|
|
|
if ($model->isReadOnly()) { |
|
127
|
|
|
return; |
|
128
|
|
|
} |
|
129
|
|
|
|
|
130
|
|
|
$rels = []; |
|
131
|
|
|
$relationships = $this->modelService->getRelationships($model); |
|
132
|
|
|
|
|
133
|
|
|
if ($relationships['count'] > 0) { |
|
134
|
|
|
$class->addUseStatement('Tobscure\\JsonApi\\Relationship'); |
|
135
|
|
|
} |
|
136
|
|
|
|
|
137
|
|
|
foreach ($relationships['all'] as $rel) { |
|
138
|
|
|
if ($rel['type'] == 'one') { |
|
139
|
|
|
$fk = $rel['fk']; |
|
140
|
|
|
$foreignModel = $fk->getForeignTable(); |
|
141
|
|
|
|
|
142
|
|
|
$refPhpName = $fk->getPhpName(); |
|
143
|
|
|
if ($refPhpName === null) { |
|
144
|
|
|
$refPhpName = $foreignModel->getPhpName(); |
|
145
|
|
|
} |
|
146
|
|
|
|
|
147
|
|
|
$name = NameUtils::dasherize($refPhpName); |
|
|
|
|
|
|
148
|
|
|
$method = NameUtils::toCamelCase($refPhpName); |
|
149
|
|
|
$crudMethod = $refPhpName; |
|
150
|
|
|
$rels[$name] = $foreignModel->getPhpName() . '::getSerializer()->getType(null)'; |
|
151
|
|
|
$class->addUseStatement($foreignModel->getNamespace() . '\\' . $foreignModel->getPhpName()); |
|
152
|
|
|
$class->addUseStatement('Tobscure\\JsonApi\\Resource'); |
|
153
|
|
|
|
|
154
|
|
|
// read |
|
155
|
|
|
$body = $this->twig->render('to-one-read.twig', [ |
|
156
|
|
|
'ref' => $refPhpName, |
|
157
|
|
|
'class' => $foreignModel->getPhpName() |
|
158
|
|
|
]); |
|
159
|
|
|
|
|
160
|
|
|
// set |
|
161
|
|
|
$class->setMethod(PhpMethod::create('set'.$crudMethod) |
|
162
|
|
|
->addParameter(PhpParameter::create('model')) |
|
163
|
|
|
->addParameter(PhpParameter::create('data')) |
|
164
|
|
|
->setBody($this->twig->render('to-one-set.twig', [ |
|
165
|
|
|
'ref' => $refPhpName |
|
166
|
|
|
])) |
|
167
|
|
|
); |
|
168
|
|
|
} |
|
169
|
|
|
|
|
170
|
|
|
if ($rel['type'] == 'many') { |
|
171
|
|
|
$fk = $rel['fk']; |
|
172
|
|
|
$foreignModel = $fk->getForeignTable(); |
|
173
|
|
|
|
|
174
|
|
|
$refPhpName = $rel['lk']->getRefPhpName(); |
|
175
|
|
|
if ($refPhpName === null) { |
|
176
|
|
|
$refPhpName = $foreignModel->getPhpName(); |
|
177
|
|
|
} |
|
178
|
|
|
|
|
179
|
|
|
$name = NameUtils::dasherize($refPhpName); |
|
|
|
|
|
|
180
|
|
|
$method = NameUtils::toCamelCase($refPhpName); |
|
181
|
|
|
$crudMethod = NameUtils::pluralize($refPhpName); |
|
182
|
|
|
$rels[$name] = $foreignModel->getPhpName() . '::getSerializer()->getType(null)'; |
|
183
|
|
|
$class->addUseStatement($foreignModel->getNamespace() . '\\' . $foreignModel->getPhpName()); |
|
184
|
|
|
$class->addUseStatement($foreignModel->getNamespace() . '\\' . $foreignModel->getPhpName() . 'Query'); |
|
185
|
|
|
$class->addUseStatement('Tobscure\\JsonApi\\Collection'); |
|
186
|
|
|
|
|
187
|
|
|
// read |
|
188
|
|
|
$body = $this->twig->render('to-many-read.twig', [ |
|
189
|
|
|
'getter' => NameUtils::pluralize($refPhpName), |
|
190
|
|
|
'class' => $refPhpName |
|
191
|
|
|
]); |
|
192
|
|
|
|
|
193
|
|
|
// set |
|
194
|
|
|
$class->addUseStatement($rel['cfk']->getMiddleTable()->getNamespace() . '\\' .$rel['cfk']->getMiddleTable()->getPhpName() . 'Query'); |
|
195
|
|
|
$class->setMethod(PhpMethod::create('set'.$crudMethod) |
|
196
|
|
|
->addParameter(PhpParameter::create('model')) |
|
197
|
|
|
->addParameter(PhpParameter::create('data')) |
|
198
|
|
|
->setBody($this->twig->render('to-many-set.twig', [ |
|
199
|
|
|
'query_class' => $rel['cfk']->getMiddleTable()->getPhpName(), |
|
200
|
|
|
'class' => $refPhpName, |
|
201
|
|
|
'adder' => $crudMethod |
|
202
|
|
|
])) |
|
203
|
|
|
); |
|
204
|
|
|
|
|
205
|
|
|
// add |
|
206
|
|
|
$class->setMethod(PhpMethod::create('add'.$crudMethod) |
|
207
|
|
|
->addParameter(PhpParameter::create('model')) |
|
208
|
|
|
->addParameter(PhpParameter::create('data')) |
|
209
|
|
|
->setBody($this->twig->render('to-many-add.twig', [ |
|
210
|
|
|
'ref' => $refPhpName, |
|
211
|
|
|
'ref_var' => $method |
|
212
|
|
|
])) |
|
213
|
|
|
); |
|
214
|
|
|
|
|
215
|
|
|
// remove |
|
216
|
|
|
$class->setMethod(PhpMethod::create('remove'.$crudMethod) |
|
217
|
|
|
->addParameter(PhpParameter::create('model')) |
|
218
|
|
|
->addParameter(PhpParameter::create('data')) |
|
219
|
|
|
->setBody($this->twig->render('to-many-remove.twig', [ |
|
220
|
|
|
'ref' => $refPhpName, |
|
221
|
|
|
'ref_var' => $method |
|
222
|
|
|
])) |
|
223
|
|
|
); |
|
224
|
|
|
} |
|
225
|
|
|
|
|
226
|
|
|
// needs to go down |
|
227
|
|
|
$class->setMethod(PhpMethod::create($method) |
|
|
|
|
|
|
228
|
|
|
->addParameter(PhpParameter::create('model')) |
|
229
|
|
|
->addParameter(PhpParameter::create('related')) |
|
230
|
|
|
->setBody($body) |
|
|
|
|
|
|
231
|
|
|
); |
|
232
|
|
|
} |
|
233
|
|
|
|
|
234
|
|
|
$class->setMethod(PhpMethod::create('getRelationships') |
|
235
|
|
|
->setBody($this->twig->render('getRelationships.twig', [ |
|
236
|
|
|
'fields' => $rels |
|
237
|
|
|
])) |
|
238
|
|
|
); |
|
239
|
|
|
} |
|
240
|
|
|
} |
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.