Drupal\mongodb_watchdog\Event

Complexity

Total Complexity

6

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	2	1
A	location()	0	2	1
A	uid()	0	2	1
A	bsonUnserialize()	0	4	3

<?php

declare(strict_types=1);

namespace Drupal\mongodb_watchdog;

use Drupal\Core\Logger\RfcLogLevel;

The type Drupal\Core\Logger\RfcLogLevel was not found. Maybe you did not declare it correctly or list all dependencies?

use MongoDB\BSON\ObjectIdInterface;
use MongoDB\BSON\Unserializable;

/**
 * Class Event is a value object for a logged event.
 *
 * @package Drupal\mongodb_watchdog
 *
 * Since this is essentially a value object, naming is constrained by the
 * property names in MongoDB, so ignore variable naming rules for fields.
 *
 * @SuppressWarnings(PHPMD.CamelCasePropertyName)
 * @SuppressWarnings(Variable)
 */
class Event implements Unserializable {
  const KEYS = [
    '_id',
    'hostname',
    'link',
    'location',
    'message',
    'referrer',
    'severity',
    'timestamp',
    'type',
    'uid',
    'variables',
    'requestTracking_id',
    'requestTracking_sequence',
  ];

  // @codingStandardsIgnoreStart
  /**
   * A MongoId.
   *
   * @var \MongoDB\BSON\ObjectIdInterface
   */
  public ObjectIdInterface $_id;
  // @codingStandardsIgnoreEnd

  /**
   * User id. Use uid() instead for type safety.
   *
   * @var ?int
   */
  public ?int $uid = 0;

  /**
   * Event type, often a module name.
   *
   * @var ?string
   */
  public ?string $type;

  /**
   * Event template.
   *
   * @var ?string
   */
  public ?string $message;

  // @codingStandardsIgnoreStart
  /**
   * The identifier of the request during which this event occurred.
   *
   * Coding standards are suspended for requestTracking_id which is required by
   * the MongoDB property.
   *
   * @var ?string
   */
  public ?string $requestTracking_id;
  // @codingStandardsIgnoreEnd

  // @codingStandardsIgnoreStart
  /**
   * The sequence number of the event during the request when it happened.
   *
   * Coding standards are suspended for requestTracking_sequence which is
   * required by the MongoDB property.
   *
   * @var ?int
   */
  public ?int $requestTracking_sequence = 0;
  // @codingStandardsIgnoreEnd

  /**
   * The template parameters.
   *
   * @var ?array<string,mixed>
   */
  public ?array $variables = [];

  /**
   * A RFC5424 severity level.
   *
   * @var ?int
   */
  public ?int $severity = RfcLogLevel::DEBUG;

  /**
   * A link provided by the event emitter. Optional.
   *
   * @var ?string
   */
  public ?string $link;

  /**
   * The absolute URL for the path on which event was logged. Use location().
   *
   * @var ?string
   */
  public ?string $location;

  /**
   * A HTTP referrer for the path on which the event was logged. Optional.
   *
   * @var ?string
   */
  public ?string $referrer;

  /**
   * The server host.
   *
   * @var ?string
   */
  public ?string $hostname;

  /**
   * The timestamp at which the event was logged.
   *
   * @var ?int
   */
  public ?int $timestamp = 0;

  /**
   * Constructor.
   *
   * @param array<mixed,mixed> $event
   *   The event in array form.
   */
  public function __construct(array $event) {
    $this->bsonUnserialize($event);
  }

  /**
   * {@inheritdoc}
   *
   * @param array<mixed,mixed> $data
   *   The raw data, from which we will only pick up those we want.
   */
  public function bsonUnserialize(array $data): void {
    foreach (static::KEYS as $key) {
      if (isset($data[$key])) {
        $this->{$key} = $data[$key];
      }
    }
  }

  /**
   * Type-safe getter for location.
   *
   * @return string
   *   The location property, always as a string, never NULL.
   */
  public function location(): string {
    return $this->location ?? '';
  }

  /**
   * Type-safe getter for uid.
   *
   * @return int
   *   The uid property, always as an int, never NULL.
   */
  public function uid(): int {
    return $this->uid ?? 0;
  }

}