Completed
Push — master ( 111c7d...cc6796 )
by Vitaly
02:51
created

Generator::createQueryClass()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 48
Code Lines 35

Duplication

Lines 0
Ratio 0 %

Importance

Changes 8
Bugs 0 Features 2
Metric Value
c 8
b 0
f 2
dl 0
loc 48
rs 9.125
cc 3
eloc 35
nc 3
nop 4
1
<?php
2
/**
3
 * Created by PhpStorm.
4
 * User: VITALYIEGOROV
5
 * Date: 09.12.15
6
 * Time: 14:34
7
 */
8
namespace samsoncms\api;
9
10
use samsonframework\orm\DatabaseInterface;
11
12
/**
13
 * Entity classes generator.
14
 * @package samsoncms\api
15
 */
16
class Generator
17
{
18
    /** @var DatabaseInterface */
19
    protected $database;
20
21
    /**
22
     * Transliterate string to english.
23
     *
24
     * @param string $string Source string
25
     * @return string Transliterated string
26
     */
27
    protected function transliterated($string)
28
    {
29
        return str_replace(
30
            ' ',
31
            '',
32
            ucwords(iconv("UTF-8", "UTF-8//IGNORE", strtr($string, array(
33
                            "'" => "",
34
                            "`" => "",
35
                            "-" => " ",
36
                            "_" => " ",
37
                            "а" => "a", "А" => "a",
38
                            "б" => "b", "Б" => "b",
39
                            "в" => "v", "В" => "v",
40
                            "г" => "g", "Г" => "g",
41
                            "д" => "d", "Д" => "d",
42
                            "е" => "e", "Е" => "e",
43
                            "ж" => "zh", "Ж" => "zh",
44
                            "з" => "z", "З" => "z",
45
                            "и" => "i", "И" => "i",
46
                            "й" => "y", "Й" => "y",
47
                            "к" => "k", "К" => "k",
48
                            "л" => "l", "Л" => "l",
49
                            "м" => "m", "М" => "m",
50
                            "н" => "n", "Н" => "n",
51
                            "о" => "o", "О" => "o",
52
                            "п" => "p", "П" => "p",
53
                            "р" => "r", "Р" => "r",
54
                            "с" => "s", "С" => "s",
55
                            "т" => "t", "Т" => "t",
56
                            "у" => "u", "У" => "u",
57
                            "ф" => "f", "Ф" => "f",
58
                            "х" => "h", "Х" => "h",
59
                            "ц" => "c", "Ц" => "c",
60
                            "ч" => "ch", "Ч" => "ch",
61
                            "ш" => "sh", "Ш" => "sh",
62
                            "щ" => "sch", "Щ" => "sch",
63
                            "ъ" => "", "Ъ" => "",
64
                            "ы" => "y", "Ы" => "y",
65
                            "ь" => "", "Ь" => "",
66
                            "э" => "e", "Э" => "e",
67
                            "ю" => "yu", "Ю" => "yu",
68
                            "я" => "ya", "Я" => "ya",
69
                            "і" => "i", "І" => "i",
70
                            "ї" => "yi", "Ї" => "yi",
71
                            "є" => "e", "Є" => "e"
72
                        )
73
                    )
74
                )
75
            )
76
        );
77
    }
78
79
    /**
80
     * Get class constant name by its value.
81
     *
82
     * @param string $value Constant value
83
     * @param string $className Class name
84
     * @return string Full constant name
85
     */
86
    protected function constantNameByValue($value, $className = Field::ENTITY)
87
    {
88
        // Get array where class constants are values and their values are keys
89
        $nameByValue = array_flip((new \ReflectionClass($className))->getConstants());
90
91
        // Try to find constant by its value
92
        if (isset($nameByValue[$value])) {
93
            // Return constant name
94
            return $nameByValue[$value];
95
        }
96
    }
97
98
    /**
99
     * Get correct entity name.
100
     *
101
     * @param string $navigationName Original navigation entity name
102
     * @return string Correct PHP-supported entity name
103
     */
104
    protected function entityName($navigationName)
105
    {
106
        return ucfirst($this->transliterated($navigationName));
107
    }
108
109
    /**
110
     * Get correct full entity name with name space.
111
     *
112
     * @param string $navigationName Original navigation entity name
113
     * @param string $namespace Namespace
114
     * @return string Correct PHP-supported entity name
115
     */
116
    protected function fullEntityName($navigationName, $namespace = __NAMESPACE__)
117
    {
118
        return '\\'.$namespace.'\\'.$this->entityName($navigationName);
119
    }
120
121
    /**
122
     * Get correct field name.
123
     *
124
     * @param string $fieldName Original field name
125
     * @return string Correct PHP-supported field name
126
     */
127
    protected function fieldName($fieldName)
128
    {
129
        return $fieldName = lcfirst($this->transliterated($fieldName));
0 ignored issues
show
Unused Code introduced by
$fieldName is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
130
    }
131
132
    /**
133
     * Get additional field type in form of Field constant name
134
     * by database additional field type identifier.
135
     *
136
     * @param integer $fieldType Additional field type identifier
137
     * @return string Additional field type constant
138
     */
139
    protected function additionalFieldType($fieldType)
140
    {
141
        return 'Field::'.$this->constantNameByValue($fieldType);
142
    }
143
144
    /**
145
     * Generate Query::where() analog for specific field.
146
     *
147
     * @param string $fieldName Field name
148
     * @param string $fieldId Field primary identifier
149
     * @param string $fieldType Field PHP type
150
     * @return string Generated PHP method code
151
     */
152
    protected function generateFieldConditionMethod($fieldName, $fieldId, $fieldType)
153
    {
154
        $code = "\n\t" . '/**';
155
        $code .= "\n\t" . ' * Add '.$fieldName.'(#' . $fieldId . ') field query condition.';
156
        $code .= "\n\t" . ' * @param '.Field::phpType($fieldType).' $value Field value';
157
        $code .= "\n\t" . ' * @return self Chaining';
158
        $code .= "\n\t" . ' * @see Generic::where()';
159
        $code .= "\n\t" . ' */';
160
        $code .= "\n\t" . 'public function ' . $fieldName . '($value)';
161
        $code .= "\n\t" . "{";
162
        $code .= "\n\t\t" . 'return $this->where("'.$fieldName.'", $value);';
163
164
        return $code . "\n\t" . "}"."\n";
165
    }
166
167
    /**
168
     * Create entity PHP class code.
169
     *
170
     * @param string $navigationName Original entity name
171
     * @param string $entityName PHP entity name
172
     * @param array $navigationFields Collection of entity additional fields
173
     * @return string Generated entity query PHP class code
174
     */
175
    protected function createEntityClass($navigationName, $entityName, $navigationFields)
176
    {
177
        $class = "\n\n" . '/** Class for getting "'.$navigationName.'" instances from database */';
178
        $class .= "\n" . 'class ' . $entityName . ' extends Entity';
179
        $class .= "\n" . '{';
180
181
        // Iterate additional fields
182
        foreach ($navigationFields as $fieldID => $fieldRow) {
183
            $fieldName = $this->fieldName($fieldRow['Name']);
184
185
            $class .= "\n\t" . '/** @var ' . Field::phpType($fieldRow['Type']) . ' Field #' . $fieldID . '*/';
186
            $class .= "\n\t" . 'public $' . $fieldName . ';';
187
        }
188
189
        $class .= "\n\t";
190
        $class .= "\n\t" . '/** @var string Not transliterated entity name */';
191
        $class .= "\n\t" . 'protected static $viewName = "' . $navigationName . '";';
192
        $class .= "\n" . '}';
193
194
        return $class;
195
    }
196
197
    /**
198
     * Create entity query PHP class code.
199
     *
200
     * @param integer $navigationID Entity navigation identifier
201
     * @param string $navigationName Original entity name
202
     * @param string $entityName PHP entity name
203
     * @param array $navigationFields Collection of entity additional fields
204
     * @return string Generated entity query PHP class code
205
     */
206
    protected function createQueryClass($navigationID, $navigationName, $entityName, $navigationFields)
207
    {
208
        $class = "\n\n" . '/** Class for getting "'.$navigationName.'" instances from database */';
209
        $class .= "\n" . 'class ' . $entityName . ' extends Generic';
210
        $class .= "\n" . '{';
211
212
        // Iterate additional fields
213
        $localizedFieldIDs = array();
214
        $notLocalizedFieldIDs = array();
215
        $allFieldIDs = array();
216
        $allFieldValueColumns = array();
217
        foreach ($navigationFields as $fieldID => $fieldRow) {
218
            $fieldName = $this->fieldName($fieldRow['Name']);
219
220
            $class .= $this->generateFieldConditionMethod(
221
                $fieldName,
222
                $fieldRow[Field::F_PRIMARY],
223
                $fieldRow[Field::F_TYPE]
224
            );
225
226
            // Store field metadata
227
            $allFieldIDs[] = '"' . $fieldID . '" => "' . $fieldName . '"';
228
            $allFieldValueColumns[] = '"' . $fieldID . '" => "' . Field::valueColumn($fieldRow[Field::F_TYPE]) . '"';
229
            if ($fieldRow[Field::F_LOCALIZED] == 1) {
230
                $localizedFieldIDs[] = '"' . $fieldID . '" => "' . $fieldName . '"';
231
            } else {
232
                $notLocalizedFieldIDs[] = '"' . $fieldID . '" => "' . $fieldName . '"';
233
            }
234
        }
235
236
        $class .= "\n\t";
237
        $class .= "\n\t" . '/** @var string Not transliterated entity name */';
238
        $class .= "\n\t" . 'protected static $identifier = "'.$this->fullEntityName($navigationName).'";';
239
        $class .= "\n\t" . '/** @var array Collection of navigation identifiers */';
240
        $class .= "\n\t" . 'protected static $navigationIDs = array(' . $navigationID . ');';
241
        $class .= "\n\t" . '/** @var array Collection of localized additional fields identifiers */';
242
        $class .= "\n\t" . 'protected static $localizedFieldIDs = array(' . "\n\t\t". implode(','."\n\t\t", $localizedFieldIDs) . "\n\t".');';
243
        $class .= "\n\t" . '/** @var array Collection of NOT localized additional fields identifiers */';
244
        $class .= "\n\t" . 'protected static $notLocalizedFieldIDs = array(' . "\n\t\t". implode(','."\n\t\t", $notLocalizedFieldIDs) . "\n\t".');';
245
        $class .= "\n\t" . '/** @var array Collection of all additional fields identifiers */';
246
        $class .= "\n\t" . 'protected static $fieldIDs = array(' . "\n\t\t". implode(','."\n\t\t", $allFieldIDs) . "\n\t".');';
247
        $class .= "\n\t" . '/** @var array Collection of additional fields value column names */';
248
        $class .= "\n\t" . 'protected static $fieldValueColumns = array(' . "\n\t\t". implode(','."\n\t\t", $allFieldValueColumns) . "\n\t".');';
249
        $class .= "\n" . '}';
250
251
        // Replace tabs with spaces
252
        return $class;
253
    }
254
255
    /** @return string Entity state hash */
256
    public function entityHash()
257
    {
258
        // Получим информацию о всех таблицах из БД
259
        return md5(serialize($this->database->fetch(
260
            'SELECT `TABLES`.`TABLE_NAME` as `TABLE_NAME`
261
              FROM `information_schema`.`TABLES` as `TABLES`
262
              WHERE `TABLES`.`TABLE_SCHEMA`="' . $this->database->database() . '";'
263
        )));
264
    }
265
266
    /** @return array Get collection of navigation objects */
267
    protected function entityNavigations($type = 0)
268
    {
269
        return $this->database->fetch('
270
        SELECT * FROM `structure`
271
        WHERE `Active` = "1" AND `Type` = "'.$type.'"'
272
        );
273
    }
274
275
    /** @return array Collection of navigation additional fields */
276
    protected function navigationFields($navigationID)
277
    {
278
        $return = array();
279
        // TODO: Optimize queries make one single query with only needed data
280
        foreach ($this->database->fetch('SELECT * FROM `structurefield` WHERE `StructureID` = "' . $navigationID . '" AND `Active` = "1"') as $fieldStructureRow) {
281
            foreach ($this->database->fetch('SELECT * FROM `field` WHERE `FieldID` = "' . $fieldStructureRow['FieldID'] . '"') as $fieldRow) {
282
                $return[$fieldRow['FieldID']] = $fieldRow;
283
            }
284
        }
285
286
        return $return;
287
    }
288
289
    /**
290
     * Generate entity classes.
291
     *
292
     * @param string $namespace Base namespace for generated classes
293
     * @return string Generated PHP code for entity classes
294
     */
295
    public function createEntityClasses($namespace = __NAMESPACE__)
296
    {
297
        $classes = "\n" . 'namespace ' . $namespace . ';';
298
        $classes .= "\n";
299
        $classes .= "\n" . 'use '.$namespace.'\Field;';
300
        $classes .= "\n" . 'use '.$namespace.'\query\Generic;';
301
302
        // Iterate all structures
303
        foreach ($this-> entityNavigations() as $structureRow) {
304
            $navigationFields = $this->navigationFields($structureRow['StructureID']);
305
            $entityName = $this->entityName($structureRow['Name']);
306
307
            $classes .= $this->createEntityClass(
308
                $structureRow['Name'],
309
                $entityName,
310
                $navigationFields
311
            );
312
313
            $classes .= $this->createQueryClass(
314
                $structureRow['StructureID'],
315
                $structureRow['Name'],
316
                $entityName.'Query',
317
                $navigationFields
318
            );
319
        }
320
321
        // Make correct code formatting
322
        return str_replace("\t", '    ', $classes);
323
    }
324
325
    /**
326
     * Generator constructor.
327
     * @param DatabaseInterface $database Database instance
328
     */
329
    public function __construct(DatabaseInterface $database)
330
    {
331
        $this->database = $database;
332
    }
333
}
334