class PublisherActions in Acquia Content Hub 8.2

Provides basic publisher actions like re-export functionality.

@package Drupal\acquia_contenthub_publisher

Hierarchy

• class \Drupal\acquia_contenthub_publisher\PublisherActions

2 files declare their use of PublisherActions

AcquiaContentHubPublisherAuditEntityCommands.php in modules/acquia_contenthub_publisher/src/Commands/AcquiaContentHubPublisherAuditEntityCommands.php

ReExport.php in modules/acquia_contenthub_publisher/src/EventSubscriber/HandleWebhook/ReExport.php

1 string reference to 'PublisherActions'

acquia_contenthub_publisher.services.yml in modules/acquia_contenthub_publisher/acquia_contenthub_publisher.services.yml

modules/acquia_contenthub_publisher/acquia_contenthub_publisher.services.yml

1 service uses PublisherActions

acquia_contenthub_publisher.actions in modules/acquia_contenthub_publisher/acquia_contenthub_publisher.services.yml

Drupal\acquia_contenthub_publisher\PublisherActions

File

modules/acquia_contenthub_publisher/src/PublisherActions.php, line 15

Namespace

Drupal\acquia_contenthub_publisher

class PublisherActions {

  /**
   * The Publisher Tracker.
   *
   * @var \Drupal\acquia_contenthub_publisher\PublisherTracker
   */
  protected $publisherTracker;

  /**
   * The Content Hub Common Actions Service.
   *
   * @var \Drupal\acquia_contenthub\ContentHubCommonActions
   */
  protected $commonActions;

  /**
   * The Depcalc Cache Backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $backend;

  /**
   * PublisherActions constructor.
   *
   * @param \Drupal\acquia_contenthub_publisher\PublisherTracker $publisher_tracker
   *   The Publisher Tracker.
   * @param \Drupal\acquia_contenthub\ContentHubCommonActions $common_actions
   *   The Content Hub Common Actions Service.
   * @param \Drupal\depcalc\Cache\DepcalcCacheBackend $depcalc_cache
   *   The Depcalc Cache Backend.
   */
  public function __construct(PublisherTracker $publisher_tracker, ContentHubCommonActions $common_actions, DepcalcCacheBackend $depcalc_cache) {
    $this->publisherTracker = $publisher_tracker;
    $this->commonActions = $common_actions;
    $this->backend = $depcalc_cache;
  }

  /**
   * Re-enqueues Entity by cleaning its dependencies and hashes.
   *
   * This method re-enqueues an entity by first making a calculation of all its
   * dependencies, then deleting the depcalc cache entries and nullifying the
   * hashes for all of them. It ensures that the export will be executed fresh
   * from the start.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to republish.
   * @param array $dependencies
   *   An array of entity dependency UUIDs.
   * @param string $op
   *   The operation to perform: 'insert' or 'update'.
   *
   * @throws \Exception
   */
  public function reExportEntityFull(EntityInterface $entity, array $dependencies = [], string $op = 'update') {
    if (!in_array($op, [
      'insert',
      'update',
    ])) {
      throw new \Exception(sprintf('Wrong operation provided (op = "%s") to re-queue entity %s/%s for export.', $op, $entity
        ->getEntityTypeId(), $entity
        ->id()));
    }

    // Recalculate entity dependencies, if not given.
    if (empty($dependencies) || !Uuid::isValid(reset($dependencies))) {
      $cdfs = $this->commonActions
        ->getEntityCdfFullKeyedByUuids($entity);

      // Using array_keys() to only pass the dependency UUIDs, not the hashes.
      $dependencies = array_keys($cdfs[$entity
        ->uuid()]
        ->getDependencies());
    }

    // Deleting 'depcalc' cache entries for this entity and dependencies.
    $uuids = array_merge([
      $entity
        ->uuid(),
    ], $dependencies);
    $this->backend
      ->deleteMultiple($uuids);
    $this->publisherTracker
      ->nullifyHashes([], [], $uuids);
    _acquia_contenthub_publisher_enqueue_entity($entity, $op);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PublisherActions::$backend	protected	property	The Depcalc Cache Backend.
PublisherActions::$commonActions	protected	property	The Content Hub Common Actions Service.
PublisherActions::$publisherTracker	protected	property	The Publisher Tracker.
PublisherActions::reExportEntityFull	public	function	Re-enqueues Entity by cleaning its dependencies and hashes.
PublisherActions::__construct	public	function	PublisherActions constructor.