trait DependencySerializationTrait
Same name in other branches
- 8.9.x core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php \Drupal\Core\DependencyInjection\DependencySerializationTrait
- 10 core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php \Drupal\Core\DependencyInjection\DependencySerializationTrait
- 11.x core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php \Drupal\Core\DependencyInjection\DependencySerializationTrait
Provides dependency injection friendly methods for serialization.
Hierarchy
- trait \Drupal\Core\DependencyInjection\DependencySerializationTrait
51 files declare their use of DependencySerializationTrait
- AccountProxy.php in core/
lib/ Drupal/ Core/ Session/ AccountProxy.php - CachedStorage.php in core/
lib/ Drupal/ Core/ Config/ CachedStorage.php - ConfigBase.php in core/
lib/ Drupal/ Core/ Config/ ConfigBase.php - ConfigImporter.php in core/
lib/ Drupal/ Core/ Config/ ConfigImporter.php - ContentTranslationHandler.php in core/
modules/ content_translation/ src/ ContentTranslationHandler.php
File
-
core/
lib/ Drupal/ Core/ DependencyInjection/ DependencySerializationTrait.php, line 12
Namespace
Drupal\Core\DependencyInjectionView source
trait DependencySerializationTrait {
/**
* An array of service IDs keyed by property name used for serialization.
*
* @var array
*/
// phpcs:ignore Drupal.Classes.PropertyDeclaration
protected $_serviceIds = [];
/**
* An array of entity type IDs keyed by the property name of their storages.
*
* @var array
*/
// phpcs:ignore Drupal.Classes.PropertyDeclaration
protected $_entityStorages = [];
/**
* {@inheritdoc}
*/
public function __sleep() {
$vars = get_object_vars($this);
try {
$container = \Drupal::getContainer();
$reverse_container = $container->has(ReverseContainer::class) ? $container->get(ReverseContainer::class) : new ReverseContainer($container);
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 $e) {
// No container, no problem.
}
return array_keys($vars);
}
/**
* {@inheritdoc}
*/
public function __wakeup() {
// Tests in isolation potentially unserialize in the parent process.
$phpunit_bootstrap = isset($GLOBALS['__PHPUNIT_BOOTSTRAP']);
if ($phpunit_bootstrap && !\Drupal::hasContainer()) {
return;
}
$container = \Drupal::getContainer();
foreach ($this->_serviceIds as $key => $service_id) {
// In rare cases, when test data is serialized in the parent process,
// there is a service container but it doesn't contain all expected
// services. To avoid fatal errors during the wrap-up of failing tests, we
// check for this case, too.
if ($phpunit_bootstrap && !$container->has($service_id)) {
continue;
}
$this->{$key} = $container->get($service_id);
}
$this->_serviceIds = [];
// In rare cases, when test data is serialized in the parent process, there
// is a service container but it doesn't contain all expected services. To
// avoid fatal errors during the wrap-up of failing tests, we check for this
// case, too.
if ($this->_entityStorages && (!$phpunit_bootstrap || $container->has('entity_type.manager'))) {
/** @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 = [];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | ||
DependencySerializationTrait::$_serviceIds | protected | property | ||
DependencySerializationTrait::__sleep | public | function | 1 | |
DependencySerializationTrait::__wakeup | public | function | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.