blob: 6be8704e166000c7fb66f79b4163051c363dd3b1 (
plain) (
blame)
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
|
<?php
namespace Drupal\Core\DependencyInjection;
use Drupal\Component\DependencyInjection\ReverseContainer;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
/**
* Provides dependency injection friendly methods for serialization.
*/
trait DependencySerializationTrait {
/**
* An array of service IDs keyed by property name used for serialization.
*
* @var array
*/
// phpcs:ignore Drupal.Classes.PropertyDeclaration, Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
protected $_serviceIds = [];
/**
* An array of entity type IDs keyed by the property name of their storages.
*
* @var array
*/
// phpcs:ignore Drupal.Classes.PropertyDeclaration, Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
protected $_entityStorages = [];
/**
* {@inheritdoc}
*/
public function __sleep(): array {
$vars = get_object_vars($this);
try {
$container = \Drupal::getContainer();
$reverse_container = $container->get(ReverseContainer::class);
foreach ($vars as $key => $value) {
if (!is_object($value) || $value instanceof TranslatableMarkup) {
// Ignore properties that cannot be services.
continue;
}
if ($value instanceof EntityStorageInterface) {
// If a class member is an entity storage, only store the entity type
// ID the storage is for, so it can be used to get a fresh object on
// unserialization. By doing this we prevent possible memory leaks
// when the storage is serialized and it contains a static cache of
// entity objects. Additionally we ensure that we'll not have multiple
// storage objects for the same entity type and therefore prevent
// returning different references for the same entity.
$this->_entityStorages[$key] = $value->getEntityTypeId();
unset($vars[$key]);
}
elseif ($service_id = $reverse_container->getId($value)) {
// If a class member was instantiated by the dependency injection
// container, only store its ID so it can be used to get a fresh
// object on unserialization.
$this->_serviceIds[$key] = $service_id;
unset($vars[$key]);
}
}
}
catch (ContainerNotInitializedException) {
// No container, no problem.
}
return array_keys($vars);
}
/**
* {@inheritdoc}
*/
public function __wakeup(): void {
// Avoid trying to wakeup if there's nothing to do.
if (empty($this->_serviceIds) && empty($this->_entityStorages)) {
return;
}
$container = \Drupal::getContainer();
foreach ($this->_serviceIds as $key => $service_id) {
$this->$key = $container->get($service_id);
}
$this->_serviceIds = [];
if ($this->_entityStorages) {
/** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
$entity_type_manager = $container->get('entity_type.manager');
foreach ($this->_entityStorages as $key => $entity_type_id) {
$this->$key = $entity_type_manager->getStorage($entity_type_id);
}
}
$this->_entityStorages = [];
}
}
|
