class BlockField in Entity Usage 8.3

Tracks usage of entities related in block_field fields.

Plugin annotation

@EntityUsageTrack(
  id = "block_field",
  label = @Translation("Block Field"),
  description = @Translation("Tracks relationships created with 'Block Field' fields."),
  field_types = {"block_field"},
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_usage\EntityUsageTrackBase implements ContainerFactoryPluginInterface, EntityUsageTrackInterface
      • class \Drupal\entity_usage\Plugin\EntityUsage\Track\BlockField

File

src/Plugin/EntityUsage/Track/BlockField.php, line 20

Namespace

Drupal\entity_usage\Plugin\EntityUsage\Track

class BlockField extends EntityUsageTrackBase {

  /**
   * {@inheritdoc}
   */
  public function getTargetEntities(FieldItemInterface $item) {

    /** @var \Drupal\block_field\BlockFieldItemInterface $item */
    $block_instance = $item
      ->getBlock();
    if (!$block_instance) {
      return [];
    }
    $target_type = NULL;
    $target_id = NULL;

    // If there is a view inside this block, track the view entity instead.
    if ($block_instance
      ->getBaseId() === 'views_block') {
      list($view_name, $display_id) = explode('-', $block_instance
        ->getDerivativeId(), 2);

      // @todo worth trying to track the display id as well?
      // At this point the view is supposed to exist. Only track it if so.
      if ($this->entityTypeManager
        ->getStorage('view')
        ->load($view_name)) {
        $target_type = 'view';
        $target_id = $view_name;
      }
    }
    elseif ($block_instance instanceof BlockContentBlock && ($uuid = $block_instance
      ->getDerivativeId())) {
      $blocks = $this->entityTypeManager
        ->getStorage('block_content')
        ->loadByProperties([
        'uuid' => $uuid,
      ]);
      if (!empty($blocks)) {

        // Doing this here means that an initial save operation of a host entity
        // will likely not track this block, once it does not exist at this
        // point. However, it's preferable to miss that and ensure we only track
        // lodable entities.
        $block = reset($blocks);
        $target_id = $block
          ->id();
        $target_type = 'block_content';
      }
    }
    elseif ($block_instance instanceof BlockPluginInterface && !$block_instance instanceof BlockContentBlock) {
      $target_id = $block_instance
        ->getPluginId();
      $target_type = 'block';
    }
    else {
      throw new \Exception('Block saved as target entity is not one of the trackable block types.');
    }
    return $target_type && $target_id ? [
      $target_type . '|' . $target_id,
    ] : [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockField::getTargetEntities	public	function	Retrieve the target entity(ies) from a field item value. Overrides EntityUsageTrackInterface::getTargetEntities
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityUsageTrackBase::$config	protected	property	The Entity Update config.
EntityUsageTrackBase::$entityFieldManager	protected	property	Entity field manager service.
EntityUsageTrackBase::$entityRepository	protected	property	The EntityRepository service.
EntityUsageTrackBase::$entityTypeManager	protected	property	Entity type manager service.
EntityUsageTrackBase::$usageService	protected	property	The usage tracking service.
EntityUsageTrackBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
EntityUsageTrackBase::defaultConfiguration	public	function
EntityUsageTrackBase::getAllBottomLevelTargets	protected	function	Calculates all bottom-level targets for a given entity.
EntityUsageTrackBase::getApplicableFieldTypes	public	function	Returns the field types this plugin is capable of tracking. Overrides EntityUsageTrackInterface::getApplicableFieldTypes
EntityUsageTrackBase::getDescription	public	function	Returns the tracking method description. Overrides EntityUsageTrackInterface::getDescription
EntityUsageTrackBase::getId	public	function	Returns the tracking method unique id. Overrides EntityUsageTrackInterface::getId
EntityUsageTrackBase::getLabel	public	function	Returns the tracking method label. Overrides EntityUsageTrackInterface::getLabel
EntityUsageTrackBase::getReferencingFields	public	function	Retrieve fields of the given types on an entity. Overrides EntityUsageTrackInterface::getReferencingFields
EntityUsageTrackBase::isApplicable	protected	function	Detects whether this plugin should act on a particular entity.
EntityUsageTrackBase::trackOnEntityCreation	public	function	Track usage updates on the creation of entities. Overrides EntityUsageTrackInterface::trackOnEntityCreation
EntityUsageTrackBase::trackOnEntityUpdate	public	function	Track usage updates on the edition of entities. Overrides EntityUsageTrackInterface::trackOnEntityUpdate
EntityUsageTrackBase::__construct	public	function	Plugin constructor. Overrides PluginBase::__construct	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.