1
|
|
|
<?php |
2
|
|
|
//[PHPCOMPRESSOR(remove,start)] |
3
|
|
|
/** |
4
|
|
|
* Created by Vitaly Iegorov <[email protected]>. |
5
|
|
|
* on 22.03.16 at 15:46 |
6
|
|
|
*/ |
7
|
|
|
namespace samsoncms\api\generator; |
8
|
|
|
|
9
|
|
|
use samsoncms\api\generator\metadata\RealMetadata; |
10
|
|
|
use samsonphp\generator\Generator; |
11
|
|
|
|
12
|
|
|
/** |
13
|
|
|
* Real entity query class generator. |
14
|
|
|
* |
15
|
|
|
* @package samsoncms\api\generator |
16
|
|
|
*/ |
17
|
|
|
class RealQuery extends Generic |
18
|
|
|
{ |
19
|
|
|
/** @var string Query returned entity class name */ |
20
|
|
|
protected $entityClass; |
21
|
|
|
|
22
|
|
|
/** |
23
|
|
|
* Query constructor. |
24
|
|
|
* |
25
|
|
|
* @param Generator $generator |
26
|
|
|
* @param $metadata |
27
|
|
|
*/ |
28
|
|
View Code Duplication |
public function __construct(Generator $generator, $metadata) |
|
|
|
|
29
|
|
|
{ |
30
|
|
|
parent::__construct($generator, $metadata); |
31
|
|
|
|
32
|
|
|
$this->className .= 'Query'; |
33
|
|
|
$this->parentClass = '\\' . \samsoncms\api\query\Record::class; |
34
|
|
|
$this->entityClass = '\samsoncms\api\generated\\' . $metadata->entity; |
35
|
|
|
} |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* Class uses generation part. |
39
|
|
|
* |
40
|
|
|
* @param RealMetadata $metadata Entity metadata |
41
|
|
|
*/ |
42
|
|
|
protected function createUses($metadata) |
43
|
|
|
{ |
44
|
|
|
$this->generator |
45
|
|
|
->newLine('use samsonframework\orm\ArgumentInterface;') |
46
|
|
|
->newLine(); |
47
|
|
|
} |
48
|
|
|
|
49
|
|
|
/** |
50
|
|
|
* Class definition generation part. |
51
|
|
|
* |
52
|
|
|
* @param RealMetadata $metadata Entity metadata |
53
|
|
|
*/ |
54
|
|
|
protected function createDefinition($metadata) |
55
|
|
|
{ |
56
|
|
|
$this->generator |
57
|
|
|
->multiComment(array( |
58
|
|
|
'Class for querying and fetching "' . $metadata->entity . '" instances from database', |
59
|
|
|
'@method ' . $this->entityClass . ' first();', |
60
|
|
|
'@method ' . $this->entityClass . '[] find();', |
61
|
|
|
)) |
62
|
|
|
->defClass($this->className, $this->parentClass); |
63
|
|
|
} |
64
|
|
|
|
65
|
|
|
/** |
66
|
|
|
* Class static fields generation part. |
67
|
|
|
* |
68
|
|
|
* @param RealMetadata $metadata Entity metadata |
69
|
|
|
*/ |
70
|
|
|
protected function createStaticFields($metadata) |
71
|
|
|
{ |
72
|
|
|
$this->generator |
73
|
|
|
->commentVar('string', 'Entity full class name') |
74
|
|
|
->defClassVar('$identifier', 'protected static', $this->entityClass) |
75
|
|
|
->commentVar('array', 'Collection of localized additional fields identifiers') |
76
|
|
|
->defClassVar('$fieldIDs', 'protected static', $metadata->fields) |
77
|
|
|
->commentVar('array', 'Collection of additional field names') |
78
|
|
|
->defClassVar('$fieldNames', 'protected static', $metadata->fieldNames); |
79
|
|
|
} |
80
|
|
|
|
81
|
|
|
/** |
82
|
|
|
* Class methods generation part. |
83
|
|
|
* |
84
|
|
|
* @param RealMetadata $metadata Entity metadata |
85
|
|
|
*/ |
86
|
|
View Code Duplication |
protected function createMethods($metadata) |
|
|
|
|
87
|
|
|
{ |
88
|
|
|
$methods = []; |
89
|
|
|
// TODO: Add different method generation depending on their field type |
90
|
|
|
// Generate Query::where() analog for specific field. |
91
|
|
|
foreach ($metadata->fields as $fieldID => $fieldName) { |
92
|
|
|
$code = "\n\t" . '/**'; |
93
|
|
|
$code .= "\n\t" . ' * Add ' . $fieldName . '(#' . $fieldID . ') field query condition.'; |
94
|
|
|
$code .= "\n\t" . ' * @see Generic::where()'; |
95
|
|
|
$code .= "\n\t" . ' * @param ' . $metadata->types[$fieldID] . ' $value Field value'; |
96
|
|
|
$code .= "\n\t" . ' * @param string $relation Field to value condition relation'; |
97
|
|
|
$code .= "\n\t" . ' *'; |
98
|
|
|
$code .= "\n\t" . ' * @return $this Chaining'; |
99
|
|
|
$code .= "\n\t" . ' */'; |
100
|
|
|
$code .= "\n\t" . 'public function ' . $fieldName . '($value, $relation = ArgumentInterface::EQUAL)'; |
101
|
|
|
$code .= "\n\t" . '{'; |
102
|
|
|
$code .= "\n\t\t" . 'return $this->where(\'' . $fieldName . '\', $value, $relation);'; |
103
|
|
|
$code .= "\n\t" . '}'; |
104
|
|
|
|
105
|
|
|
$methods[] = $code; |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
// Add method text to generator |
109
|
|
|
$this->generator->text(implode("\n", $methods)); |
110
|
|
|
} |
111
|
|
|
} |
112
|
|
|
//[PHPCOMPRESSOR(remove,end)] |
113
|
|
|
|
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.