View source
<?php
namespace Drupal\entity_usage;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\RevisionableInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Plugin\PluginBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
abstract class EntityUsageTrackBase extends PluginBase implements EntityUsageTrackInterface, ContainerFactoryPluginInterface {
protected $usageService;
protected $entityTypeManager;
protected $entityFieldManager;
protected $config;
protected $entityRepository;
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityUsage $usage_service, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, ConfigFactoryInterface $config_factory, EntityRepositoryInterface $entity_repository) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->configuration += $this
->defaultConfiguration();
$this->usageService = $usage_service;
$this->entityTypeManager = $entity_type_manager;
$this->entityFieldManager = $entity_field_manager;
$this->config = $config_factory
->get('entity_usage.settings');
$this->entityRepository = $entity_repository;
}
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_usage.usage'), $container
->get('entity_type.manager'), $container
->get('entity_field.manager'), $container
->get('config.factory'), $container
->get('entity.repository'));
}
public function defaultConfiguration() {
return [];
}
public function getId() {
return $this->pluginDefinition['id'];
}
public function getLabel() {
return $this->pluginDefinition['label'];
}
public function getDescription() {
return $this->pluginDefinition['description'] ?: '';
}
public function getApplicableFieldTypes() {
return $this->pluginDefinition['field_types'] ?: [];
}
public function trackOnEntityCreation(EntityInterface $source_entity) {
$trackable_field_types = $this
->getApplicableFieldTypes();
$fields = array_keys($this
->getReferencingFields($source_entity, $trackable_field_types));
foreach ($fields as $field_name) {
if ($source_entity
->hasField($field_name) && !$source_entity->{$field_name}
->isEmpty()) {
foreach ($source_entity->{$field_name} as $field_item) {
$target_entities = $this
->getTargetEntities($field_item);
foreach ($target_entities as $target_entity) {
list($target_type, $target_id) = explode("|", $target_entity);
$source_vid = $source_entity instanceof RevisionableInterface && $source_entity
->getRevisionId() ? $source_entity
->getRevisionId() : 0;
$this->usageService
->registerUsage($target_id, $target_type, $source_entity
->id(), $source_entity
->getEntityTypeId(), $source_entity
->language()
->getId(), $source_vid, $this->pluginId, $field_name);
}
}
}
}
}
public function trackOnEntityUpdate(EntityInterface $source_entity) {
$trackable_field_types = $this
->getApplicableFieldTypes();
$fields = array_keys($this
->getReferencingFields($source_entity, $trackable_field_types));
foreach ($fields as $field_name) {
if ($source_entity instanceof RevisionableInterface && $source_entity
->getRevisionId() != $source_entity->original
->getRevisionId() && $source_entity
->hasField($field_name) && !$source_entity->{$field_name}
->isEmpty()) {
$this
->trackOnEntityCreation($source_entity);
return;
}
$current_targets = [];
if ($source_entity
->hasField($field_name) && !$source_entity->{$field_name}
->isEmpty()) {
foreach ($source_entity->{$field_name} as $field_item) {
$target_entities = $this
->getTargetEntities($field_item);
foreach ($target_entities as $target_entity) {
$current_targets[] = $target_entity;
}
}
}
$original_targets = [];
if ($source_entity->original
->hasField($field_name) && !$source_entity->original->{$field_name}
->isEmpty()) {
foreach ($source_entity->original->{$field_name} as $field_item) {
$target_entities = $this
->getTargetEntities($field_item);
foreach ($target_entities as $target_entity) {
$original_targets[] = $target_entity;
}
}
}
$original_targets = array_unique($original_targets);
$current_targets = array_unique($current_targets);
$added_ids = array_diff($current_targets, $original_targets);
$removed_ids = array_diff($original_targets, $current_targets);
foreach ($added_ids as $added_entity) {
list($target_type, $target_id) = explode('|', $added_entity);
$source_vid = $source_entity instanceof RevisionableInterface && $source_entity
->getRevisionId() ? $source_entity
->getRevisionId() : 0;
$this->usageService
->registerUsage($target_id, $target_type, $source_entity
->id(), $source_entity
->getEntityTypeId(), $source_entity
->language()
->getId(), $source_vid, $this->pluginId, $field_name);
}
foreach ($removed_ids as $removed_entity) {
list($target_type, $target_id) = explode('|', $removed_entity);
$source_vid = $source_entity instanceof RevisionableInterface && $source_entity
->getRevisionId() ? $source_entity
->getRevisionId() : 0;
$this->usageService
->registerUsage($target_id, $target_type, $source_entity
->id(), $source_entity
->getEntityTypeId(), $source_entity
->language()
->getId(), $source_vid, $this->pluginId, $field_name, 0);
}
}
}
public function getReferencingFields(EntityInterface $source_entity, array $field_types) {
$source_entity_type_id = $source_entity
->getEntityTypeId();
$all_fields_on_bundle = $this->entityFieldManager
->getFieldDefinitions($source_entity_type_id, $source_entity
->bundle());
$referencing_fields_on_bundle = [];
foreach ($all_fields_on_bundle as $field_name => $field) {
if (in_array($field
->getType(), $field_types)) {
$referencing_fields_on_bundle[$field_name] = $field;
}
}
if (!$this->config
->get('track_enabled_base_fields')) {
foreach ($referencing_fields_on_bundle as $key => $referencing_field_on_bundle) {
if ($referencing_field_on_bundle
->getFieldStorageDefinition()
->isBaseField()) {
unset($referencing_fields_on_bundle[$key]);
}
}
}
return $referencing_fields_on_bundle;
}
}