-
Notifications
You must be signed in to change notification settings - Fork 645
/
AbstractEntity.php
258 lines (233 loc) · 9 KB
/
AbstractEntity.php
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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
<?php
/*
* This file is part of EC-CUBE
*
* Copyright(c) EC-CUBE CO.,LTD. All Rights Reserved.
*
* http://www.ec-cube.co.jp/
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Eccube\Entity;
use Doctrine\Common\Collections\Collection;
use Doctrine\Inflector\Inflector;
use Doctrine\Inflector\NoopWordInflector;
use Doctrine\ORM\Mapping\Id;
use Doctrine\ORM\Mapping\MappedSuperclass;
use Doctrine\ORM\Proxy\Proxy;
use Eccube\DependencyInjection\Facade\AnnotationReaderFacade;
use Eccube\Util\StringUtil;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;
use Symfony\Component\Serializer\Serializer;
/** @MappedSuperclass */
abstract class AbstractEntity implements \ArrayAccess
{
#[\ReturnTypeWillChange]
public function offsetExists($offset)
{
$inflector = new Inflector(new NoopWordInflector(), new NoopWordInflector());
$method = $inflector->classify($offset);
return method_exists($this, $method)
|| method_exists($this, "get$method")
|| method_exists($this, "is$method")
|| method_exists($this, "has$method");
}
#[\ReturnTypeWillChange]
public function offsetSet($offset, $value)
{
}
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
$inflector = new Inflector(new NoopWordInflector(), new NoopWordInflector());
$method = $inflector->classify($offset);
if (method_exists($this, $method)) {
return $this->$method();
} elseif (method_exists($this, "get$method")) {
return $this->{"get$method"}();
} elseif (method_exists($this, "is$method")) {
return $this->{"is$method"}();
} elseif (method_exists($this, "has$method")) {
return $this->{"has$method"}();
}
}
#[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
}
/**
* 引数の連想配列を元にプロパティを設定します.
* DBから取り出した連想配列を, プロパティへ設定する際に使用します.
*
* @param array $arrProps プロパティの情報を格納した連想配列
* @param \ReflectionClass $parentClass 親のクラス. 本メソッドの内部的に使用します.
* @param string[] $excludeAttribute 除外したいフィールド名の配列
*/
public function setPropertiesFromArray(array $arrProps, array $excludeAttribute = [], \ReflectionClass $parentClass = null)
{
if (is_object($parentClass)) {
$objReflect = $parentClass;
} else {
$objReflect = new \ReflectionClass($this);
}
$arrProperties = $objReflect->getProperties();
foreach ($arrProperties as $objProperty) {
$objProperty->setAccessible(true);
$name = $objProperty->getName();
if (in_array($name, $excludeAttribute) || !array_key_exists($name, $arrProps)) {
continue;
}
$objProperty->setValue($this, $arrProps[$name]);
}
// 親クラスがある場合は再帰的にプロパティを取得
$parentClass = $objReflect->getParentClass();
if (is_object($parentClass)) {
self::setPropertiesFromArray($arrProps, $excludeAttribute, $parentClass);
}
}
/**
* Convert to associative array.
*
* Symfony Serializer Component is expensive, and hard to implementation.
* Use for encoder only.
*
* @param \ReflectionClass $parentClass parent class. Use internally of this method..
* @param array $excludeAttribute Array of field names to exclusion.
*
* @return array
*/
public function toArray(array $excludeAttribute = ['__initializer__', '__cloner__', '__isInitialized__'], \ReflectionClass $parentClass = null)
{
if (is_object($parentClass)) {
$objReflect = $parentClass;
} else {
$objReflect = new \ReflectionClass($this);
}
$arrProperties = $objReflect->getProperties();
$arrResults = [];
foreach ($arrProperties as $objProperty) {
$objProperty->setAccessible(true);
$name = $objProperty->getName();
if (in_array($name, $excludeAttribute)) {
continue;
}
$arrResults[$name] = $objProperty->getValue($this);
}
$parentClass = $objReflect->getParentClass();
if (is_object($parentClass)) {
$arrParents = self::toArray($excludeAttribute, $parentClass);
if (!is_array($arrParents)) {
$arrParents = [];
}
if (!is_array($arrResults)) {
$arrResults = [];
}
$arrResults = array_merge($arrParents, $arrResults);
}
return $arrResults;
}
/**
* Convert to associative array, and normalize to association properties.
*
* The type conversion such as:
* - Datetime :: W3C datetime format string
* - AbstractEntity :: associative array such as [id => value]
* - PersistentCollection :: associative array of [[id => value], [id => value], ...]
*
* @param array $excludeAttribute Array of field names to exclusion.
*
* @return array
*/
public function toNormalizedArray(array $excludeAttribute = ['__initializer__', '__cloner__', '__isInitialized__'])
{
$arrResult = $this->toArray($excludeAttribute);
foreach ($arrResult as &$value) {
if ($value instanceof \DateTime) {
// see also https://stackoverflow.com/a/17390817/4956633
$value->setTimezone(new \DateTimeZone('UTC'));
$value = $value->format('Y-m-d\TH:i:s\Z');
} elseif ($value instanceof AbstractEntity) {
// Entity の場合は [id => value] の配列を返す
$value = $this->getEntityIdentifierAsArray($value);
} elseif ($value instanceof Collection) {
// Collection の場合は ID を持つオブジェクトの配列を返す
$Collections = $value;
$value = [];
foreach ($Collections as $Child) {
$value[] = $this->getEntityIdentifierAsArray($Child);
}
}
}
return $arrResult;
}
/**
* Convert to JSON.
*
* @param array $excludeAttribute Array of field names to exclusion.
*
* @return string
*/
public function toJSON(array $excludeAttribute = ['__initializer__', '__cloner__', '__isInitialized__'])
{
return json_encode($this->toNormalizedArray($excludeAttribute));
}
/**
* Convert to XML.
*
* @param array $excludeAttribute Array of field names to exclusion.
*
* @return string
*/
public function toXML(array $excludeAttribute = ['__initializer__', '__cloner__', '__isInitialized__'])
{
$ReflectionClass = new \ReflectionClass($this);
$serializer = new Serializer([new PropertyNormalizer()], [new XmlEncoder([XmlEncoder::ROOT_NODE_NAME => $ReflectionClass->getShortName()])]);
$xml = $serializer->serialize($this->toNormalizedArray($excludeAttribute), 'xml');
if ('\\' === DIRECTORY_SEPARATOR) {
// The m modifier of the preg functions converts the end-of-line to '\n'
$xml = StringUtil::convertLineFeed($xml, "\r\n");
}
return $xml;
}
/**
* コピー元のオブジェクトのフィールド名を指定して、同名のフィールドに値をコピー
*
* @param object $srcObject コピー元のオブジェクト
* @param string[] $excludeAttribute 除外したいフィールド名の配列
*
* @return AbstractEntity
*/
public function copyProperties($srcObject, array $excludeAttribute = [])
{
$this->setPropertiesFromArray($srcObject->toArray($excludeAttribute), $excludeAttribute);
return $this;
}
/**
* Convert to Entity of Identity value to associative array.
*
* @param AbstractEntity $Entity
*
* @return array associative array of [[id => value], [id => value], ...]
*/
public function getEntityIdentifierAsArray(AbstractEntity $Entity)
{
$Result = [];
$PropReflect = new \ReflectionClass($Entity);
if ($Entity instanceof Proxy) {
// Doctrine Proxy の場合は親クラスを取得
$PropReflect = $PropReflect->getParentClass();
}
$Properties = $PropReflect->getProperties();
foreach ($Properties as $Property) {
$AnnotationReader = AnnotationReaderFacade::create();
$anno = $AnnotationReader->getPropertyAnnotation($Property, Id::class);
if ($anno) {
$Property->setAccessible(true);
$Result[$Property->getName()] = $Property->getValue($Entity);
}
}
return $Result;
}
}