class PublisherTracker in Acquia Content Hub 8.2

The publisher tracker table class.

Hierarchy

class \Drupal\acquia_contenthub_publisher\PublisherTracker uses AcquiaContentHubStatusMetricsTrait

Expanded class hierarchy of PublisherTracker

10 files declare their use of PublisherTracker

AcquiaContentHubEnqueueEntitiesCommands.php in modules/acquia_contenthub_publisher/src/Commands/AcquiaContentHubEnqueueEntitiesCommands.php
AcquiaContentHubPublisherAuditCommands.php in modules/acquia_contenthub_publisher/src/Commands/AcquiaContentHubPublisherAuditCommands.php
AcquiaContentHubPublisherAuditEntityCommands.php in modules/acquia_contenthub_publisher/src/Commands/AcquiaContentHubPublisherAuditEntityCommands.php
acquia_contenthub_publisher.module in modules/acquia_contenthub_publisher/acquia_contenthub_publisher.module: Drupal Module: Acquia Content Hub - Publisher.
ContentHubExportQueueWorker.php in modules/acquia_contenthub_publisher/src/Plugin/QueueWorker/ContentHubExportQueueWorker.php

... See full list

1 string reference to 'PublisherTracker'

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 PublisherTracker

acquia_contenthub_publisher.tracker in modules/acquia_contenthub_publisher/acquia_contenthub_publisher.services.yml: Drupal\acquia_contenthub_publisher\PublisherTracker

File

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

Namespace

Drupal\acquia_contenthub_publisher

View source

class PublisherTracker {
  use AcquiaContentHubStatusMetricsTrait;
  const QUEUED = 'queued';
  const EXPORTED = 'exported';
  const CONFIRMED = 'confirmed';

  /**
   * The name of the tracking table.
   */
  const EXPORT_TRACKING_TABLE = 'acquia_contenthub_publisher_export_tracking';

  /**
   * PublisherTracker constructor.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   */
  public function __construct(Connection $database) {
    $this->database = $database;
  }

  /**
   * Gets the tracking entity for a given uuid.
   *
   * @param string $uuid
   *   The entity uuid.
   *
   * @return \Drupal\Core\Database\StatementInterface|int|null
   *   Database statement
   */
  public function get(string $uuid) {
    $query = $this->database
      ->select(self::EXPORT_TRACKING_TABLE, 't')
      ->fields('t', [
      'entity_uuid',
    ]);
    $query
      ->condition('entity_uuid', $uuid);
    return $query
      ->execute()
      ->fetchObject();
  }

  /**
   * Gets the tracking record for a given uuid.
   *
   * @param string $uuid
   *   The entity uuid.
   *
   * @return \Drupal\Core\Database\StatementInterface|int|null
   *   Database statement
   */
  public function getRecord(string $uuid) {
    $query = $this->database
      ->select(self::EXPORT_TRACKING_TABLE, 't')
      ->fields('t');
    $query
      ->condition('entity_uuid', $uuid);
    return $query
      ->execute()
      ->fetchObject();
  }

  /**
   * Gets the Queue ID for a given uuid.
   *
   * @param string $uuid
   *   The entity uuid.
   * @param bool $tracker_only
   *   TRUE to check only the tracker, FALSE (default) to check the queue table.
   *
   * @return int|null|bool
   *   The Queue ID or FALSE.
   */
  public function getQueueId(string $uuid, bool $tracker_only = FALSE) {
    $query = $this->database
      ->select(self::EXPORT_TRACKING_TABLE, 't')
      ->fields('t', [
      'queue_id',
    ]);
    $query
      ->condition('entity_uuid', $uuid);
    $queue_id = $query
      ->execute()
      ->fetchField();
    if ($tracker_only || empty($queue_id)) {
      return $queue_id;
    }

    // Is the existing item in the Drupal "queue"?
    return $this->database
      ->query('SELECT item_id FROM {' . DatabaseQueue::TABLE_NAME . '} WHERE item_id = :queue_id', [
      ':queue_id' => $queue_id,
    ])
      ->fetchField();
  }

  /**
   * Add tracking for an entity in a self::EXPORTED state.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity for which to add tracking.
   * @param string $hash
   *   A sha1 hash of the data attribute for change management.
   *
   * @throws \Exception
   */
  public function track(EntityInterface $entity, string $hash) {
    $this
      ->insertOrUpdate($entity, self::EXPORTED, $hash);
  }

  /**
   * Add tracking for an entity in a self::QUEUED state.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity for which to add tracking.
   *
   * @throws \Exception
   */
  public function queue(EntityInterface $entity) {
    $this
      ->insertOrUpdate($entity, self::QUEUED);
  }

  /**
   * Remove tracking for an entity.
   *
   * @param string $uuid
   *   The uuid for which to remove tracking.
   *
   * @return \Drupal\Core\Database\StatementInterface|int|null
   *   Database statement
   *
   * @throws \Exception
   */
  public function delete(string $uuid) {
    $query = $this->database
      ->delete(self::EXPORT_TRACKING_TABLE);
    $query
      ->condition('entity_uuid', $uuid);
    return $query
      ->execute();
  }

  /**
   * Determines if an entity will be inserted or updated with a status.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to add tracking to.
   * @param string $status
   *   The status of the tracking.
   * @param string $hash
   *   A sha1 hash of the data attribute for change management.
   *
   * @return \Drupal\Core\Database\StatementInterface|int|null
   *   Database statement.
   *
   * @throws \Exception
   */
  protected function insertOrUpdate(EntityInterface $entity, string $status, string $hash = '') {
    if ($entity instanceof EntityChangedInterface) {
      $modified = date('c', $entity
        ->getChangedTime());
    }
    else {
      $modified = date('c');
    }

    // If we've previously tracked this thing, set its created date.
    if ($entity instanceof NodeInterface) {
      $created = date('c', $entity
        ->getCreatedTime());
    }
    else {
      $created = $modified;
    }

    // Must check because of created field.
    $results = $this
      ->get($entity
      ->uuid());

    // If entity in the table update fields but not all of them.
    if ($results) {
      $values = [
        'status' => $status,
        'modified' => $modified,
        'entity_uuid' => $entity
          ->uuid(),
      ];
      if ($hash) {
        $values['hash'] = $hash;
      }
    }
    else {
      $values = [
        'entity_type' => $entity
          ->getEntityTypeId(),
        'entity_id' => $entity
          ->id(),
        'entity_uuid' => $entity
          ->uuid(),
        'status' => $status,
        'created' => $created,
        'modified' => $modified,
        'hash' => $hash,
      ];
    }
    return $this->database
      ->merge(self::EXPORT_TRACKING_TABLE)
      ->key('entity_uuid', $entity
      ->uuid())
      ->fields($values)
      ->execute();
  }

  /**
   * Set the queue item of a particular record by its uuid.
   *
   * @param string $uuid
   *   The uuid of an entity.
   * @param string $queue_id
   *   The status to set.
   *
   * @throws \Exception
   */
  public function setQueueItemByUuid(string $uuid, string $queue_id) {
    if (!$this
      ->isTracked($uuid)) {
      return;
    }
    $query = $this->database
      ->update(self::EXPORT_TRACKING_TABLE);
    $query
      ->fields([
      'queue_id' => $queue_id,
    ]);
    $query
      ->condition('entity_uuid', $uuid);
    $query
      ->execute();
  }

  /**
   * Checks if a particular entity uuid is tracked.
   *
   * @param string $uuid
   *   The uuid of an entity.
   *
   * @return bool
   *   Whether or not the entity is tracked in the subscriber tables.
   */
  public function isTracked(string $uuid) {
    $query = $this->database
      ->select(self::EXPORT_TRACKING_TABLE, 't');
    $query
      ->fields('t', [
      'entity_type',
      'entity_id',
    ]);
    $query
      ->condition('entity_uuid', $uuid);
    return (bool) $query
      ->execute()
      ->fetchObject();
  }

  /**
   * Nullify queue_id when entities lose their queued state.
   *
   * @param string $uuid
   *   The uuid of an entity.
   */
  public function nullifyQueueId(string $uuid) {
    $query = $this->database
      ->update(self::EXPORT_TRACKING_TABLE);
    $query
      ->fields([
      'queue_id' => '',
    ]);
    $query
      ->condition('entity_uuid', $uuid);
    $query
      ->execute();
  }

  /**
   * Obtains a list of tracked entities.
   *
   * @param string|array $status
   *   The status of the entities to list or an array of statuses.
   * @param string $entity_type_id
   *   The Entity type.
   *
   * @return array
   *   An array of Tracked Entities set to reindex.
   */
  public function listTrackedEntities($status, string $entity_type_id = '') : array {
    if (!is_array($status)) {
      $status = [
        $status,
      ];
    }
    $query = $this->database
      ->select(self::EXPORT_TRACKING_TABLE, 'ci')
      ->fields('ci')
      ->condition('status', $status, 'IN');
    if (!empty($entity_type_id)) {
      $query = $query
        ->condition('entity_type', $entity_type_id);
    }
    return $query
      ->execute()
      ->fetchAll(\PDO::FETCH_ASSOC);
  }

  /**
   * Nullifies hashes in the Publisher Tracker.
   *
   * @param array $statuses
   *   An array of status.
   * @param array $entity_types
   *   An array of entity types.
   * @param array $uuids
   *   An array of Entity UUIDs.
   */
  public function nullifyHashes(array $statuses = [], array $entity_types = [], array $uuids = []) {
    $query = $this->database
      ->update(PublisherTracker::EXPORT_TRACKING_TABLE);
    $query
      ->fields([
      'hash' => '',
    ]);
    if (!empty($statuses)) {
      $query
        ->condition('status', $statuses, 'IN');
    }
    if (!empty($entity_types)) {
      $query
        ->condition('entity_type', $entity_types, 'IN');
    }
    if (!empty($uuids)) {
      $query
        ->condition('entity_uuid', $uuids, 'IN');
    }
    $query
      ->execute();
  }

}

Members

Name	Modifiers	Type	Description
AcquiaContentHubStatusMetricsTrait::$database	protected	property	The database connection.
AcquiaContentHubStatusMetricsTrait::getMostRecentUpdateTime	public	function	Calculates updated time of most recent published tracked entity.
AcquiaContentHubStatusMetricsTrait::getStatusMetrics	public	function	Calculates metrics timestamped and indexed by status.
PublisherTracker::CONFIRMED		constant
PublisherTracker::delete	public	function	Remove tracking for an entity.
PublisherTracker::EXPORTED		constant
PublisherTracker::EXPORT_TRACKING_TABLE		constant	The name of the tracking table.
PublisherTracker::get	public	function	Gets the tracking entity for a given uuid.
PublisherTracker::getQueueId	public	function	Gets the Queue ID for a given uuid.
PublisherTracker::getRecord	public	function	Gets the tracking record for a given uuid.
PublisherTracker::insertOrUpdate	protected	function	Determines if an entity will be inserted or updated with a status.
PublisherTracker::isTracked	public	function	Checks if a particular entity uuid is tracked.
PublisherTracker::listTrackedEntities	public	function	Obtains a list of tracked entities.
PublisherTracker::nullifyHashes	public	function	Nullifies hashes in the Publisher Tracker.
PublisherTracker::nullifyQueueId	public	function	Nullify queue_id when entities lose their queued state.
PublisherTracker::queue	public	function	Add tracking for an entity in a self::QUEUED state.
PublisherTracker::QUEUED		constant
PublisherTracker::setQueueItemByUuid	public	function	Set the queue item of a particular record by its uuid.
PublisherTracker::track	public	function	Add tracking for an entity in a self::EXPORTED state.
PublisherTracker::__construct	public	function	PublisherTracker constructor.

You are here

class PublisherTracker in Acquia Content Hub 8.2

Hierarchy

File

Namespace

Members

API Navigation