contacts-8.x-1.x-dev/modules/log/src/ProfileLogger.php

<?php

declare(strict_types=1);

namespace Drupal\contacts_log;

use Drupal\profile\Entity\ProfileInterface;

/**
 * Profile logger service.
 */
class ProfileLogger extends DestructableLoggerBase {

  /**
   * An array of bundles to exclude from logging.
   *
   * @var string[]
   */
  protected $excludedBundles = [];

  /**
   * Add bundles to exclude from logging.
   *
   * @param string[] $bundles
   *   The bundles to exclude.
   *
   * @return $this
   */
  public function addExcludedBundles(array $bundles) {
    $this->excludedBundles = array_merge($this->excludedBundles, $bundles);
    return $this;
  }

  /**
   * Check whether a certain profile should be excluded from logging.
   *
   * @param \Drupal\profile\Entity\ProfileInterface $profile
   *   The profile.
   *
   * @return bool
   *   Whether the profile should be excluded.
   */
  protected function exclude(ProfileInterface $profile): bool {
    // Allow a value on the profile to indicate exclusions, for example for
    // migrations.
    if (!empty($profile->contacts_log_exclude)) {
      return TRUE;
    }

    // Allow excluding certain profile types.
    if (in_array($profile->bundle(), $this->excludedBundles)) {
      return TRUE;
    }

    // Don't log on non-existent, new or anonymous users.
    $owner = $profile->getOwner();
    return !$owner || $owner->isNew() || $owner->isAnonymous();
  }

  /**
   * React to inserting a profile.
   *
   * @param \Drupal\profile\Entity\ProfileInterface $profile
   *   The profile being inserted.
   */
  public function onInsert(ProfileInterface $profile): void {
    if ($this->exclude($profile)) {
      return;
    }

    $this->log((string) $profile->id(), [
      'template' => 'contacts_log_create_profile',
      'contact' => $profile->getOwnerId(),
      'profile' => $profile,
    ]);
  }

  /**
   * React to updating a profile.
   *
   * @param \Drupal\profile\Entity\ProfileInterface $profile
   *   The profile being updated.
   */
  public function onUpdate(ProfileInterface $profile): void {
    if ($this->exclude($profile)) {
      return;
    }

    $this->log((string) $profile->id(), [
      'template' => 'contacts_log_update_profile',
      'contact' => $profile->getOwnerId(),
      'profile' => $profile,
    ]);
  }

}