sugar-cube-client/lib/models/PayloadCommit.php

<?php
declare(strict_types=1);
namespace Gitea\Models;

use GuzzleHttp\Psr7\{Uri};
use Psr\Http\Message\{UriInterface};

/**
 * Represents a commit.
 */
class PayloadCommit implements \JsonSerializable {

  /**
   * @var PayloadUser|null The person who authored the commit.
   */
  private $author;

  /**
   * @var PayloadUser|null The person who committed the code.
   */
  private $committer;

  /**
   * @var string The commit hash.
   */
  private $id;

  /**
   * @var string The commit message.
   */
  private $message;

  /**
   * @var \DateTime|null The commit date.
   */
  private $timestamp;

  /**
   * @var UriInterface|null The URL to the commit's history.
   */
  private $url;

  /**
   * @var PayloadCommitVerification|null The GPG verification of this commit.
   */
  private $verification;

  /**
   * Creates a new payload commit.
   * @param string $id The commit hash.
   * @param string $message The commit message.
   */
  function __construct(string $id, string $message) {
    $this->id = $id;
    $this->setMessage($message);
  }

  /**
   * Returns a string representation of this object.
   * @return string The string representation of this object.
   */
  function __toString(): string {
    $json = json_encode($this, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
    return static::class." $json";
  }

  /**
   * Creates a new commit from the specified JSON map.
   * @param object $map A JSON map representing a commit.
   * @return static The instance corresponding to the specified JSON map.
   */
  static function fromJson(object $map): self {
    return (new static(isset($map->id) && is_string($map->id) ? $map->id : '', isset($map->message) && is_string($map->message) ? $map->message : ''))
      ->setAuthor(isset($map->author) && is_object($map->author) ? PayloadUser::fromJson($map->author) : null)
      ->setCommitter(isset($map->committer) && is_object($map->committer) ? PayloadUser::fromJson($map->committer) : null)
      ->setTimestamp(isset($map->timestamp) && is_string($map->timestamp) ? new \DateTime($map->timestamp) : null)
      ->setUrl(isset($map->url) && is_string($map->url) ? new Uri($map->url) : null)
      ->setVerification(isset($map->verification) && is_object($map->verification) ? PayloadCommitVerification::fromJson($map->verification) : null);
  }

  /**
   * Gets the person who authored the commit.
   * @return PayloadUser|null The person who authored the commit.
   */
  function getAuthor(): ?PayloadUser {
    return $this->author;
  }

  /**
   * Gets the person who committed the code.
   * @return PayloadUser|null The person who committed the code.
   */
  function getCommitter(): ?PayloadUser {
    return $this->committer;
  }

  /**
   * Gets the commit hash.
   * @return string The commit hash.
   */
  function getId(): string {
    return $this->id;
  }

  /**
   * Gets the commit message.
   * @return string The commit message.
   */
  function getMessage(): string {
    return $this->message;
  }

  /**
   * Gets the commit date.
   * @return \DateTime|null The commit date.
   */
  function getTimestamp(): ?\DateTime {
    return $this->timestamp;
  }

  /**
   * Gets the URL to the commit's history.
   * @return UriInterface|null The URL to the commit's history.
   */
  function getUrl(): ?UriInterface {
    return $this->url;
  }

  /**
   * Gets the GPG verification of this commit.
   * @return PayloadCommitVerification|null The GPG verification of this commit.
   */
  function getVerification(): ?PayloadCommitVerification {
    return $this->verification;
  }

  /**
   * Converts this object to a map in JSON format.
   * @return \stdClass The map in JSON format corresponding to this object.
   */
  function jsonSerialize(): \stdClass {
    return (object) [
      'author' => ($author = $this->getAuthor()) ? $author->jsonSerialize() : null,
      'committer' => ($committer = $this->getCommitter()) ? $committer->jsonSerialize() : null,
      'id' => $this->getId(),
      'message' => $this->getMessage(),
      'timestamp' => ($date = $this->getTimestamp()) ? $date->format('c') : null,
      'url' => ($url = $this->getUrl()) ? (string) $url : null,
      'verification' => ($verification = $this->getVerification()) ? $verification->jsonSerialize() : null
    ];
  }

  /**
   * Sets the person who authored the commit.
   * @param PayloadUser|null $value The new author.
   * @return $this This instance.
   */
  function setAuthor(?PayloadUser $value): self {
    $this->author = $value;
    return $this;
  }

  /**
   * Sets the person who committed the code.
   * @param PayloadUser|null $value The new committer.
   * @return $this This instance.
   */
  function setCommitter(?PayloadUser $value): self {
    $this->committer = $value;
    return $this;
  }

  /**
   * Sets the commit message.
   * @param string $value The new message.
   * @return $this This instance.
   */
  function setMessage(string $value): self {
    $this->message = $value;
    return $this;
  }

  /**
   * Sets the commit date.
   * @param \DateTime|null $value The new commit date.
   * @return $this This instance.
   */
  function setTimestamp(?\DateTime $value): self {
    $this->timestamp = $value;
    return $this;
  }

  /**
   * Sets the URL to the commit's history.
   * @param UriInterface|null $value The new commit URL.
   * @return $this This instance.
   */
  function setUrl(?UriInterface $value): self {
    $this->url = $value;
    return $this;
  }

  /**
   * Sets the commit message.
   * @param PayloadCommitVerification|null $value The new message.
   * @return $this This instance.
   */
  function setVerification(?PayloadCommitVerification $value): self {
    $this->verification = $value;
    return $this;
  }
}